https://github.com/lifeeka/koa-shell

Structured sample skeleton application for microservices and api development with Koa 2.X
https://github.com/lifeeka/koa-shell

flowtype framework koa koa2 mogoose mongodb skelton structured

Last synced: 29 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/lifeeka/koa-shell
• Owner: lifeeka
• Created: 2020-08-13T15:31:21.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-03-04T19:06:05.000Z (almost 4 years ago)
• Last Synced: 2024-11-10T03:28:35.471Z (3 months ago)
• Topics: flowtype, framework, koa, koa2, mogoose, mongodb, skelton, structured
• Language: JavaScript
• Homepage:
• Size: 778 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


## 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