huliyou / threatu-api

API Boilerplate

A RESTful API boilerplate with Koa for personal usage

Prerequisite

• Node.js ^5.x
• MongoDB ^3.x
• Redis ^3.x

Installation

$ npm install

Usage

Development

$ npm run dev

Production

$ npm run build
$ npm start

Docker

Development on local

[OS X] If you're using Docker ToolBox (or Boot2Docker) in development mode, you should use docker-osx-dev:

$ docker-osx-dev -e node_modules -e .git -e build

Waiting Docker for OS X/Windows beta release, we will not need docker-osx-dev in the future.

$ docker-compose -f docker-compose.dev.yml up

Production

$ npm run build
$ docker-compose up

Test

First start MongoDB, and run:

$ npm test
# watch
$ npm test -- --watch
# get code coverage report
$ npm run test-cov

Lint

$ npm run lint

License

MIT