table of content

• introduction
• demo
• usage
• api
• authors
• jobs
• contribute
• repository description
• license

This is WORK IN PROGRESS, do not use

holon

[back to top]

Leight-weight DSL-free dual-side composable reactive components

If you want to find holons, search npmjs.org for ecosystem:holon or browse holons

demo

[back to top]

☠☠☠ section is under construction ☠☠☠

usage

[back to top]

var componentName = require('componentName'); // encapsulates best practice boilerplate for certain kinds of projects
var componentAPI = componentName({
  container      : `domNodeOrSelector`, // maybe it should always be a dom node
  options        : {/* configuration options */}, /* some configuration depending on the project that should be built*/
  data           : `modelOrStreamOrEventEmitter`, // to initialize or update stuff /* some webpage specific data or e.g. RESTful endpoints to fetch the data */
  children       : [ // this is optional, because maybe the component can use defaults if not provided /* inject some components to be used to render page in detail - if not provided might fallback to default components */
    { '__title'  : titleComponent   },
    { '__list'   : listComponent    },
    { '__sidebar': sidebarComponent }
  ]
});

☠☠☠ section is under construction ☠☠☠

install with npm do:

npm install holon

install with git do:

git clone https://github.com/coding-amigos/holon.git

api

[back to top]

☠☠☠ section is under construction ☠☠☠

authors

[back to top]

• serapath

jobs

[back to top]

There is more jobs in the source code marked with // @TODO: <job description> and eventually some jobs might be listed under the holon issues page, which can also be accessed through waffle.io.

• @TODO: Publish it as a component
  • http://modernweb.com/2014/02/17/introduction-to-the-component-javascript-package-manager/
  • https://github.com/component/component/wiki/Components
• @TODO: Create a Github Page
  • https://github.com/jekyll/jekyll
  • https://help.github.com/categories/20/articles
• @TODO: Include Testing via "Specification Driven Development" using gherkin dsl & TESTEM
  • https://github.com/cucumber/cucumber/wiki/Gherkin
  • https://github.com/airportyh/testem
• @TODO: Add 'Leight-weight DSL-free dual-side composable "BEMified" reactive components' + more verbose description to README.markdown
• @TODO: Edit all 'under construction sections' in README.markdown (at least add "@TODO's" for them to the "Jobs Section")
• @TODO: Add CHANGELOG File
• @TODO: This section should instead list all the TODO-Branches currently available + a link to the "TODO Description file in that branch"
  • The README.markdown in that branch could list the description under the "jobs section"
• @TODO: add workflow description
  • http://www.wolfe.id.au/2014/02/01/getting-a-new-node-project-started-with-npm/
  • http://quickleft.com/blog/creating-and-publishing-a-node-js-module
  • http://www.devthought.com/2012/02/17/npm-tricks/
• @TODO: find convention for branch names, e.g. {CA-1}{SPIKE}{jeet.gs} and COMMIT NAMES

☠☠☠ section is under construction ☠☠☠

contribute

[back to top]

PREPARE SYSTEM

• install git if it is not yet installed on your system
• install node if it is not yet installed on your system
• open a terminal on your system and navigate to your favourite workspace folder
  • (you might need to prefix some of the following commands with sudo to make them work)

START PREPARING HOLON PROJECT

• git clone https://github.com/coding-amigos/holon.git
• npm install
• npm update
• stylus -u jeet -u nib -rupture -w holon.styl
• load main HTML project file by opening and pointing your browser to:
  • a server that serves the ./DEMO/dev.html file (e.g. localhost:3000/DEMO/dev.html)
  • or doubleclick ./DEMO/dev.html file to open it directly in your browser
    • HINT: this only works with CORS disabled. In order to do so:
      • mac osx open -a Google\ Chrome --args --disable-web-security
      • linux google-chrome --disable-web-security
      • windows chrome.exe --disable-web-security

... HAPPY CODING :-)

repository

[back to top]

1. ./

• Contains meta data about this component

2. ./DEMO

• Contains a file that demonstrate how to use this component in your project

3. ./DEPENDENCIES

• Contains all internal dependencies used by this component, but not yet published to their own repositories

4. ./RELEASE

• Contains production ready versions of this component which are used by examples in ./DEMO
• CDNs/REGISTRYs: v0.0.3@git, v0.0.2@npm

5. ./SOURCE

• Contains all the source files for this component

6. ./SOURCE/media

• Contains fonts, images, videos, music and the like, used by this component

7. ./SPECIFICATION

• Contains the vision, roadmap, open jobs and tests for completed jobs regarding this component

8. ./@TODO/ (currently private)

• Contains some experimental stuff for inspiration to "spike" the use of certain technologies to develop this component further

license

[back to top]

...more information