Initial Machine Setup

1. Install NodeJS 22

Get Started

1. Install npm install
2. Configure mysql connection config file
3. Run the app npm run start

Documentation

Swagger docs can be found at:

• http://localhost:3000/api-docs/

Linting

Code linters: eslint with pluggable Prettier configs.

• run: npm run lint
• fix JS errors: lint:fix Eslint configuration file: here

Testing

We use Jest for unit tests. Test file for .js should be named as .test.js and be placed along with code file.

• run unit tests: npm run test
• run tests with coverage: npm run test:cover

Refer to this document for more details.