Skip to content

Structured sample skeleton application for microservices and api development with Koa 2.X

Notifications You must be signed in to change notification settings

lifeeka/koa-shell

Repository files navigation

Koa shell.js

Structured sample skeleton application for microservices and api development with Koa 2.X

Installation

Clone the project using git clone

git clone https://github.com/lifeeka/koa-shell.js.git

Start

yarn start or npm run start

Usage

Create Service
./shell make:service test

Create Model
./shell make:model test

Create Repository
./shell make:repository test

Create Type
./shell make:type test

Create Error
./shell make:error test

Database migration
./shell migrate init initialize a new migration project
./shell migrate create [options] [description] create a new database migration with the provided description
./shell migrate up [options] run all pending database migrations
./shell migrate down [options] undo the last applied database migration
./shell migrate status [options] print the changelog of the database
./shell migrate help [command] display help for command

Stack

  • Koa 2.x
  • MongoDB with mongoose
  • Flow Types
  • ESLint with airbnb style guide

License

This project is under the MIT License