Note that this project is still in unstable stage
Master | Develop |
---|---|
Simple NodeJS boilerplate, with basic unit test powered by Mocha/Chai/Sinon;
Table of Contents
# Have Node ^6.0.0 & NPM ^3.8.6 installed
# install dependencies
npm install
# remove the built code, for now only the test result
npm run clean
# remove the built code and node modules
npm run reset
Coverage report can be found in ./coverage
folder.
npm test
The source code is written in ES2015, hence before NodeJS fully support ES2015, we need to build the code to es2015-node
using Babel.
The built code can be found in ./dist
folder.
npm run build
# generate the documentation
npm run doc
# serve the generated documentation using `http-server`
# note that no watch functionality is hooked, hence
# changing code won't trigger documentation regeneration.
npm run serve-doc
Shorthand script to generate release content, including ./coverage
, ./jsdoc
and ./dist
.
npm run release