https://github.com/jhen0409/api-boilerplate
A RESTful API boilerplate with Koa for personal usage
https://github.com/jhen0409/api-boilerplate
Last synced: 3 months ago
JSON representation
A RESTful API boilerplate with Koa for personal usage
- Host: GitHub
- URL: https://github.com/jhen0409/api-boilerplate
- Owner: jhen0409
- License: mit
- Created: 2016-03-28T08:06:08.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-11-02T18:16:05.000Z (almost 9 years ago)
- Last Synced: 2025-04-06T04:23:08.449Z (6 months ago)
- Language: JavaScript
- Size: 68.4 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# API Boilerplate [](https://travis-ci.org/jhen0409/api-boilerplate) [](https://coveralls.io/r/jhen0409/api-boilerplate?branch=master) [](https://david-dm.org/jhen0409/api-boilerplate) [](https://david-dm.org/jhen0409/api-boilerplate#info=devDependencies)
> A RESTful API boilerplate with Koa for personal usage
## Prerequisite
* Node.js ^6.x
* MongoDB ^3.x
* Redis ^3.x
## Installation
```bash
$ yarn install
```
## Usage
#### Development
```bash
$ yarn run dev
```
#### Production
```bash
$ yarn run build
$ yarn start
```
## Docker
#### Development on local
Use [Docker](https://www.docker.com/products/docker) for development.
```bash
$ docker-compose -f docker-compose.dev.yml up
```
#### Production
```bash
$ yarn run build
$ docker-compose up
```
## Test
First start MongoDB, and run:
```bash
# Lint
$ yarn run lint
# Test
$ yarn test
# Watch test
$ yarn test -- --watch
# Get code coverage report
$ yarn run test-cov
```
## License
[MIT](LICENSE.md)