Repository files navigation

This is a boilerplate application for building REST APIs in Node.js using ES6 and Express with Code Coverage and JWT Authentication. Helps you stay productive by following best practices. FollowsAirbnb's Javascript style guide.

Heavily inspired fromEgghead.io - How to Write an Open Source JavaScript Library.

• CORS support viacors
• Useshttp-status to set http status code. It is recommended to usehttpStatus.INTERNAL_SERVER_ERROR instead of directly using500 when setting status code.
• Has.editorconfig which helps developers define and maintain consistent coding styles between different editors and IDEs.

Clone the repo:

git clone git@github.com:kunalkapadia/express-mongoose-es6-rest-api.gitcd express-mongoose-es6-rest-api

Install yarn:

npminstall-gyarn

Install dependencies:

yarn

Set environment (vars):

cp .env.example .env

Start server:

# Start serveryarn start# Selectively set DEBUG env var to get logsDEBUG=express-mongoose-es6-rest-api:* yarn start

Referdebug to know how to selectively turn on logs.

Tests:

# Run tests written in ES6yarntest# Run test along with code coverageyarn test:coverage# Run tests on file changeyarn test:watch# Run tests enforcing code coverage (configured via .istanbul.yml)yarn test:check-coverage

Lint:

# Lint code with ESLintyarn lint# Run lint on any file changeyarn lint:watch

Other gulp tasks:

# Wipe out dist and coverage directorygulp clean# Default task: Wipes out dist and coverage directory. Compiles using babel.gulp

# compile to ES51. yarn build# upload dist/ to your server2. scp -rp dist/ user@dest:/path# install production dependencies only3. yarn --production# Use any process manager to start your services4. 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 recommendedhere.We recommendpm2 as it has several useful features like it can be configured to auto-start your services if system is rebooted.

Universal logging librarywinston 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 executingyarn test

yarn test also generates HTML code coverage report incoverage/ directory. Openlcov-report/index.html to view it.

# service restarts on file changebash bin/development.sh

# To use this option you need to make sure mongodb is listening on port 27017# Build dockerdocker build -t express-mongoose-es6-rest-api.# Run dockerdocker run -p 4040:4040 express-mongoose-es6-rest-api

If you would prefer not to use any of our tooling, delete the following files from the project:package.json,gulpfile.babel.js,.eslintrc and.travis.yml. You can now safely use the boilerplate with an alternative build-system or no build-system at all if you choose.

• 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.

This project is licensed under theMIT License

If this project saved your valuable time in getting your service up, and you feel like buying me coffee, you can donate either at my BTC address:1LkW5UoERR1jjJsChMheKuo6vn95x2mzWg or at

Your support is greatly appreciated.

Kunal Kapadia –@kunalkapadia12 –kunalkapadia12@gmail.com