Giter VIP home page Giter VIP logo

api-boilerplate's Introduction

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

api-boilerplate's People

Contributors

jhen0409 avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

greyme

api-boilerplate's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.