|ES6 via Babel||ES6 support using Babel.|
|Authentication via JsonWebToken||Supports authentication using jsonwebtoken.|
|Auto server restart||Restart the server using nodemon in real-time anytime an edit is made, with babel compilation and eslint.|
|ES6 Code Coverage via istanbul||Supports code coverage of ES6 code using istanbul and mocha. Code coverage reports are saved in
|Debugging via debug||Instead of inserting and deleting console.log you can replace it with the debug function and just leave it there. You can then selectively debug portions of your code by setting DEBUG env variable. If DEBUG env variable is not set, nothing is displayed to the console.|
|Promisified Code via bluebird||We love promise, don’t we ? All our code is promisified and even so our tests via supertest-as-promised.|
|API parameter validation via express-validation||Validate body, params, query, headers and cookies of a request (via middleware) and return a response with errors; if any of the configured validation rules fail. You won’t anymore need to make your route handler dirty with such validations.|
|Pre-commit hooks||Runs lint and tests before any commit is made locally, making sure that only tested and quality code is committed|
|Secure app via helmet||Helmet helps secure Express apps by setting various HTTP headers.|
- CORS support via cors
- Uses http-status to set http status code. It is recommended to use
httpStatus.INTERNAL_SERVER_ERRORinstead of directly using
500when setting status code.
.editorconfigwhich helps developers define and maintain consistent coding styles between different editors and IDEs.
Clone the repo:
git clone [email protected]:KunalKapadia/express-mongoose-es6-rest-api.git cd express-mongoose-es6-rest-api
# set DEBUG env variable to get debug logs DEBUG=express-mongoose-es6-rest-api:* npm start # OR # requires gulp to be installed globally npm i -g gulp gulp serve
# Run tests written in ES6 along with code coverage npm test # Run tests on file change npm run test:watch # Run tests enforcing code coverage (configured via .istanbul.yml) npm run test:check-coverage
Other gulp tasks:
# Wipe out dist and coverage directory gulp clean # Lint code with ESLint npm run lint npm run lint:watch # Default task: Wipes out dist and coverage directory. Compiles using babel. gulp
# compile to ES5 1. npm run build or gulp # upload dist/ to your server 2. scp -rp dist/ [email protected]:/path # install production dependencies only 3. npm i --production # Use any process manager to start your services 4. pm2 start dist/index.js
In production you need to make sure your server is always up so you should ideally use any of the process manager recommended here. We recommend pm2 as it has several useful features like it can be configured to auto-start your services if system is rebooted.
Universal logging library winston is used for logging. It has support for multiple transports. A transport is essentially a storage device for your logs. Each instance of a winston logger can have multiple transports configured at different levels. For example, one may want error logs to be stored in a persistent remote location (like a database), but all logs output to the console or a local file. We just log to the console for simplicity, you can configure more transports as per your requirement.
Logs detailed info about each api request to console during development.
Logs stacktrace of error to console along with other details. You should ideally store all error messages persistently.
Get code coverage summary on executing
npm test also generates HTML code coverage report in
coverage/ directory. Open
lcov-report/index.html to view it.
A Boilerplate-only Option
If you would prefer not to use any of our tooling, delete the following files from the project:
.travis.yml. You can now safely use the boilerplate with an alternative build-system or no build-system at all if you choose.
Docs and Recipes
- Gulp recipes - the official Gulp recipes directory includes a comprehensive list of guides for different workflows you can add to your project.
Contributions, questions and comments are all welcome and encouraged. For code contributions submit a pull request with unit test.