Skip to content

A RESTful API boilerplate with Koa for personal usage

License

Notifications You must be signed in to change notification settings

jhen0409/api-boilerplate

Repository files navigation

API Boilerplate Build Status Test coverage Dependency Status devDependency Status

A RESTful API boilerplate with Koa for personal usage

Prerequisite

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

Installation

$ yarn install

Usage

Development

$ yarn run dev

Production

$ yarn run build
$ yarn start

Docker

Development on local

Use Docker for development.

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

Production

$ yarn run build
$ docker-compose up

Test

First start MongoDB, and run:

# Lint
$ yarn run lint
# Test
$ yarn test
# Watch test
$ yarn test -- --watch
# Get code coverage report
$ yarn run test-cov

License

MIT

About

A RESTful API boilerplate with Koa for personal usage

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published