Koa API

Flexible Koa API

Development

git clone git@github.com:xskytech/koa-api.git
cd koa-api

Installation

npm version >= 5.2.0

npx @xskytech/create-koa-api koa-api

npm version < 5.2.0

npm install --global @xskytech/create-koa-api
@xskytech/create-koa-api koa-api

Configuration

Change directory

cd koa-api

Copy .env.example to .env and change data

cp .env.example .env

Linting

Check lint issues

npm run lint

Fix lint issues

npm run lint:fix

Validate

Validate application

npm run validate

Migrate

Create DB

npm run database:create

Run migrations

npm run database:migrate:up

Undo migrations

npm run database:migrate:down

Run seeds

npm run database:seed:up

Undo seeds

npm run database:seed:down

Drop DB

npm run database:drop

Run

Run in development

npm run develop

Run in production

npm start

License

This project is licensed under the MIT License. See the LICENSE file for details.