Node-express-boilerplate

This is the boilerplate of the node.js express app generated using https://github.com/fmvilas/swagger-node-codegen.

Feel free to make it up-to-dated and better.

Proprosed code structure

|+ src/
 |+ libs/               // This folder contains libs, e.g., logger
 |+ middlewares/        // This folder contains middlewares
 |+ models/             // This folder contains models
 |+ routes/             // This folder contains routes and controllers
 |+ services/           // This folder contains services
 |- app.js              // Express app configuration here
 |- app.test.js         // Test file will have the same name with `.test.js` extension
 |- config.js           // Configuration file
|- .env                 // Environment variables
|- .eslintrc            // Lint configuration
|- .nycrc               // Code coverage configuration
|- .Dockerfile          // Dockerfile
|- mocha.opts           // Mocha test configuration
|- swagger.yaml         // Swagger file that describe project strcture

Steps to generate app

Install swagger-node-codegen globally.

npm i snc -g

Generate project structure from the sample swagger file.

snc template/swagger.yaml -o ./my-express-api -t ./template/

Steps to run the express app

Goto the express app

cd my-express-api

Install dependencies

npm i

Start the server

npm start

You should see the log like this

{"name":"swagger-petstore","hostname":"xxx,"pid":72556,"level":20,"msg":"Listening on port 3000","time":"2018-12-20T18:34:52.346Z","v":0}

The server will be start at the 3000 port (default port).

Steps to call APIs

Open https://editor.swagger.io and copy template/swagger.yaml and paste there.

Select Schemes to HTTP

Click 'Try it out' button at each APIs.

Or you can simply use postman and point the url to http://localhost:3000

The apis generated from the steps above can validate data by the rule from swagger.yaml, try to remove some required fields in the request body to test it. You will get some friendly error message related to the missing fields.

Running unit test and test coverage

Test coverage configuration is defined at .nycrc. You can adjust the threshold there.

To run unit test and test coverage, type

npm run cover

The test coverage report is available at coverage/lcov-report/index.html

Running ESLint

This project is based on the airbnb style guide. You can read the document from https://github.com/airbnb/javascript

To run eslint, type

npm run lint

Health check

You can set your load balance to the url http://localhost:3000/healthcheck to perform health check.

The result should look like this

{
  status: "ok",
  info: "2018-12-21T16:58:08.091Z"
}

You can modify the health check response in the function healthCheck at src/bin/www

Graceful shutdown

If something went wrong, the server should do some clean up operation before terminating.

You can perform this kind of task in the function onSignal at src/bin/www.

By default the timeout before terminating server is 1000 ms, you can configure this value by updating SHUTDOWN_TIMEOUT in .env file

piggyman007 / node-express-boilerplate