Blog Express JS Rest API ES6

Rest Blog API ES6 with unit testing

REST resources
Body Parsing via body-parser
Integration Testing via supertest
Test code coverage via wallabyjs
Database via mongo and mongoose
Continuous Integration via travis-ci and (http://matthewmeye.rs/blog/post/templating-language-part-2/)

Example

https://blogapi-express.herokuapp.com/api/stories/
https://blogapi-express.herokuapp.com/api/stories/:storyId
https://blogapi-express.herokuapp.com/api/stories/:storyId/comments
https://blogapi-express.herokuapp.com/api/stories/:storyId/comments/:commentId
https://blogapi-express.herokuapp.com/api/users
https://blogapi-express.herokuapp.com/api/users/:userId

Getting Started

Clone the repo:

git clone git@github.com:sandropucp/blog-api-es6.git
cd blog-api-es6

Install dependencies:

npm install

Start server:

# Start server
npm start

# Selectively set DEBUG env var to get logs
DEBUG=express-mongoose-es6-rest-api:* npm start

Refer debug to know how to selectively turn on logs.

Tests:

# 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

Lint:

# Lint code with ESLint
npm run lint

# Run lint on any file change
npm run lint:watch

Other gulp tasks:

# Wipe out dist and coverage directory
gulp clean

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

Deployment

# compile to ES5
1. npm run build

# upload dist/ to your server
2. scp -rp dist/ user@dest:/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.

Logging

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.