Jaipur

Install

• Run npm install to install dependencies

Start

• Run npm run start to start the app
• Open your browser on http://localhost:3000/health

Error: listen EADDRINUSE: address already in use

You must run the application on another port.

• Run PORT=XXXX npm run start to start the app
• Open your browser on http://localhost:XXXX/health

Debug

• Run npm run start:debug to start the app in debug mode
• Press F5 to attach the vscode debugger to the node process

Test

• Run npm run test to start test suites
• Open coverage/index.html to see the tests code coverage information

Linter/Code formatter

• Run npm run lint to see errors
• Run npm run lint:fix to automatically fix errors

Files structure

• .vscode Visual Studio Code project configuration
• coverage Tests code coverage information
• node_modules Dependencies of the application
• src Sources of the application
  • database Database access object
  • routes Routes of the application
  • services Services of the application
  • app.js Application creation
  • index.js Main of the application
• .babelrc Babel configuration file
• .eslintrc ESLint configuration file
• .gitignore List of files to exclude from git
• jest.config.js Jest configuration file
• package-lock.json Informations about dependencies automatically generated (do not modify by hand)
• package.json Project description
• rules.pdf Rules of Jaipur