Git clone
then npm install
.
Requires mongo to be running in the background.
Uses Express as main framework, Gulp as taskrunner. Babel allows use of ES6 throughout. User authentication handled via bcrypt and JSON Web Tokens. User must be authenticated before accessing the organizations route.
Tests handled via Mocha/Chai/Supertest. Code coverage with nyc/Istanbul.
Logging handled by winston and debug replaces console.log
standard-version uses Angular Commit Message standard. husky enforces linting (ESLint) and runs tests before commiting.
npm run test
runs complete suite of tests for users and organizations. Displays code coverage report using nyc/Istanbul
npm run docs
generates HTML documentation from source code comments
npm start
compiles using babel and serves app with nodemon on port 4040
npm run lint
lints with ESLint
npm run release
use after merging dev branch with master. Version bumping and commit message validation.