create-koa2-app
v1.0.3
Published
Koa 2 application generator
Downloads
10
Maintainers
Readme
Koa 2' application generator. Currently only the web service mode is available.
Installation
$ npm install -g create-koa2-app
Quick Start
Create the app:
$ create-koa2-app my-app
Go to directory:
$ cd my-app
Install dependencies:
$ npm install
Copy and change environment variables from default file:
$ cp .env.default .env
Start your Koa2 app at http://localhost:3011/
:
$ npm start
Command Line Options
This generator can also be further configured with the following command line flags.
--version output the version number
-d, --db <database> add database support (mysql, postgresql, mongodb)
--redis add redis support
--git add .gitignore
-f, --force force on non-empty directory
-h, --help output usage information
TODO:
There're some features (updates) which will be included in this generator in the near future:
- [x] Add dynamic .env file.
- [x] Add appveyor.
- [x] Add support PostgreSQL.
- [ ] Improve logger (add transaction id).
- [ ] Add dockerfile.
- [ ] Add static render.
- [ ] Add tests for generator.
- [ ] Add tests for koa2 app.
- [ ] Add coverage for tests.
- [ ] Add health check for redis.
- [ ] Add support MariaDB.
- [ ] Add support clasterization.
- [ ] Add support to start app via pm2.
- [ ] Add TravisCI.
- [ ] Add tunnel to localhost (for development).