Code source documentation

TPI documentation

This project is a backend project that is in interaction with the database. It consist of a Node.js http server application, built upon the koa web framework and written in Javascript.

Available scripts

The scripts are contained into the package.json file. They are:

• Run
  • npm start to launch the server app, with watch mode and hot reload.
• Lint: npm run lint
• Automated Tests
  • npm test to run all the test.
  • npm test:unit to run unit tests.
  • npm test:unit:watch to run unit tests in watch mode.
• Technical Documentation
  • Generate code source documentation: npm run doc:code - Generate HTML documentation from code source comments into docs/html folder.
  • Generate API documentation: npm run doc:api - Generate and validate a yaml file that contains the documentation. Use online swagger-editor to see the content..