Intro

Sample project to show how all projects should set up:

• mocha, chai, istanbull code test and coverage report
• travis, coverall CI/CD, automated test and coverage report
• flow type check
• lint code style (airbnb style)
• docco in code documentation
• winston, rollbar logging and exception report

Structure

• src (source code of the project)
• tests (all tests)
  • e2e
  • integration
  • unit
• docs (generated by npm run doc)
• coverage (generated by npm test)

Commands

• npm run doc generate docs locally
• npm run github-pages generate docs locally and publish to github pages
• npm start run the code
• npm test run tests locally and generate json, html coverage report
• npm run travis run tests in travis.ci and update coverall.io

Resources

• Test Report https://travis-ci.org/pixelsandcode/nodepack
• Coverage Report https://coveralls.io/github/pixelsandcode/nodepack
• Documentation https://pixelsandcode.github.io/nodepack/src/index.html

TODO

• generate doc from tests or link tests to code doc