okolilemuel / api-koa-starter

Starter for an API server using Koa

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Rangle Koa-starter

Quick Start

This starter works with npm or yarn.

Install:

yarn # or npm install

Run in dev mode, restarting the server on file changes:

yarn dev

Run unit tests:

yarn test

Run in prod mode, not daemonized, with staging config (suitable for Heroku):

yarn build
yarn start

Start/stop in prod mode, daemonized, with local config:

yarn build
yarn local:start
yarn local:stop

Start/stop in prod mode, daemonized mode, with staging config:

yarn build
yarn staging:start
yarn staging:stop

Build (or update) the API documentation to api.html in the root:

yarn raml

About

Starter for an API server using Koa


Languages

Language:JavaScript 89.1%Language:RAML 10.9%