Client Development

Development Environment

TODO

API Documentation

Prerequisites

• Under eclairjs -node root: npm install git+https://github.com/jsdoc3/jsdoc.git

The documentation for JavaScript API's is generated from the source code using JSDoc. To generate and update the published API documentation:

1. Check out the git checkout master branch
2. ./node_modules/.bin/jsdoc -c ./jsdoc_conf.json
3. Commit updated docs to master git commit then git push
4. Checkout ```git checkout gh-pages````
5. Rebase or merge from master git rebase master
6. Commit changes to gh-pages git commit then git push
7. Verify changes were published, open browser to https://eclairjs.github.io/eclairjs/client/docs/jsdoc/
8. When complete checkout master git checkout master