koa2-restful-generator

Koa application generator.

Generating a RESTFul Koa2 template with koa2-restful-generator.

Features

Express-style
Support koa 2.x（koa middleware supported, need Node.js 7.6+ , babel optional）
Generate RESTFul API ONLY

Requirements

Item	Details
System	GNU/Linux (>=2.6.x), macOS (>=10.10.x), Windows (later than XP)
Environment	Node.js and npm

Installation

$ npm install -g koa2-restful-generator

with 1 command

koa2-restful-generator (Support koa 2.x)

Command Line Options

This generator can also be further configured with the following command line flags.

    -h, --help          output usage information
    -V, --version       output the version number
        --git           add .gitignore
    -f, --force         force on non-empty directory
    -h, --help          show help message

Quick Start

To get started in the quickest way, after you installed this package, the system will auto link script koa2-restful-generator to a directory that in your system's $PATH. Thus you can simply run the command as shown below:

Create the App

$ koa2-restful-generator test && cd ./test

then the process will auto execute npm install command in your project directory.

Start the Project

# start via dev server
$ npm run dev

# start in production mode
$ npm run production
# (production server requires pm2)

the application will start and listen on *:3000.

License

MIT