TEDxKasetsart-Backend

Badge

Badge	Description
	monitoring dependencies, by libraries.io
	monitoring vulnerabilities dependencies, by snyk.io
	code coverage, use codecov
	testing CI, use CircleCI
	analysis code and maintainability, use code climates
	code issues or problem, use code climates
	staging server
	document site

Available command

Server

Available command	Description
npm start	start server with default env
npm run start:watch	start server with default env and watch file changes
npm run start:dev	start server with develop env
npm run start:dev:watch	start server with develop env and watch file changes
npm run start:prod	start server with production env

Database

Available command	Description
npm run start:db	start mongo database server (on background)
npm run stop:db	stop mongo database server
npm run start:db:watch	start mongo database server and watch

Testing

Available command	Description
npm run test:mocha	run mocha test without any configuration
npm test	run test:mocha in test env
npm run test:watch	run test:mocha in test env and watch file changes

Code coverage

Available command	Description
npm run cov	run test and coverage, accept 1 parameter -- <report-type>
	support type text-summary, html, json-summary
npm run cov:check	run checker coverage, all of this should more and 70%
	lines , functions , statements , and branches

Linter

Available command	Description
npm run lint	run linter analysis, using eslint
npm run lint:doc	run linter analysis document, using documentation

CI testing

Available command	Description
npm run ci:test	run test, In CircleCI only
npm run ci:report	create report to codecov, In CircleCI only
npm run greenkeeper:update	run before ci:test command, manage lock file
npm run greenkeeper:upload	run after ci:test command, update lock file

Monitoring

Available command	Description
monitor:start	start monitor server, use pm2 command
monitor:stop	stop monitor server, use pm2 command
monitor:show	stop monitor information, use pm2 command
monitor:restart	restart server and monitor, use pm2 command
monitor:delete	delete server process, use pm2 command
monitor:log	show server log, use pm2 command. --lines to specify out line

I use keymetrics

Production

Available command	Description
npm run start:prod	start server with production env
npm run build:gh	build document and deploy to gh-pages branch

Document

Available command	Description
npm run build:doc	build code document to docs folder
npm run build:apidoc	build api document to apidocs folder
npm run build:doc:all	build both api and code docs
npm run build:gh	build all document and deploy to github-page
npm run deploy:doc	run lint doc and deploy document to github-page
npm run deploy:version	update application version
	accept major, minor, patch, etc.
npm run serve:doc	run document website as server