senaykt/nodejs-backend-starter

Node.js Backend Starter

Nodejs Backend Starter

How to run

1. Fork this repository
2. Ensure node (>8.6) and npm are installed
3. Run npm install
4. Run npm test
5. Run npm start
6. Hit the server to test health curl localhost:8010/health and expect a 200 response

Consists of following components

1. Documentation
2. Tooling
3. Pagination
4. Security
5. Load Testing

Documentation

Setup JSDoc to generate API documentation for the project.

Install JSDoc globally inorder to generate the documentation npm install -g jsdoc

Tooling

Consists of following

1. eslint - for linting
2. nyc - for code coverage
3. pre-push - for git pre push hook running tests
4. winston - for logging

Criteria

1. eslint should have an opinionated format
2. nyc should aim for test coverage of 80% across lines, statements, and branches
3. pre-push should run the tests before allowing pushing using git
4. winston should be used to replace console logs and all errors should be logged as well. Logs should go to disk.
5. integration to CI such as Travis or Circle - NOT DONE
6. Add Typescript support - NOT DONE

Pagination

Implement Pagination

Security

Please implement the following security controls for your system:

1. Ensure the system is not vulnerable to SQL injection

Load Testing

Please implement load testing to ensure your service can handle a high amount of traffic

1. Implement load testing using artillery
   1. Ensure that load testing is able to be run using npm test:load. You can consider using a tool like forever to spin up a daemon and kill it after the load test has completed.
   2. Test all endpoints under at least 100 rps for 30s and ensure that p99 is under 50ms