Key technologies: node, npm, express, typescript, jest, supertest, swagger

• Fully automated toolchain with npm run scripts
• Typescript
• Node ^8
• Jest + Supertest
• Passport
• Swagger
• TypeDoc
• MongoDB

npm install
npm  start     # Builds and runs nodemon or npm run build && node dist/server.js

WARNING: the folder /dist is intended for build files only. Any files manually placed in these will be deleted permanently by the project scripts

To ensure code quality testing and linting are included in this project. Testing is handled by Jest and Supertest

TSLint is used for linting.

To start the QA scripts run the following:

# run tests
npm run test

To review documentation and test existing endpoints run server:

# start server
npm run start

and open https://0.0.0.0:8000/docs.

Note: You may configure PORT and HOST for server using env variables.