Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aandrewww/create-koa2-app
👷Koa2' web service generator
https://github.com/aandrewww/create-koa2-app
cli generator koa koa2 koa2-boilerplate koa2-generator nodejs
Last synced: about 1 month ago
JSON representation
👷Koa2' web service generator
- Host: GitHub
- URL: https://github.com/aandrewww/create-koa2-app
- Owner: aandrewww
- License: mit
- Created: 2018-04-09T20:06:56.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-06-28T06:09:38.000Z (over 6 years ago)
- Last Synced: 2024-10-01T10:21:23.009Z (about 2 months ago)
- Topics: cli, generator, koa, koa2, koa2-boilerplate, koa2-generator, nodejs
- Language: JavaScript
- Homepage:
- Size: 91.8 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[Koa 2'](https://github.com/koajs/koa) application generator. Currently only the web service mode is available.
[![NPM Version][npm-image]][npm-url]
[![NPM Downloads][downloads-image]][downloads-url]
[![Build status][appveyor-image]][appveyor-url]
## Installation
```sh
$ npm install -g create-koa2-app
```
## Quick Start
Create the app:
```bash
$ create-koa2-app my-app
```
Go to directory:
```bash
$ cd my-app
```
Install dependencies:
```bash
$ npm install
```
Copy and change environment variables from default file:
```bash
$ cp .env.default .env
```
Start your Koa2 app at `http://localhost:3011/`:
```bash
$ 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 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).
## Author
* [Andrew Avdeev](https://andrewavdeev.com/)
## License
[MIT](LICENSE)
[npm-image]: https://img.shields.io/npm/v/create-koa2-app.svg
[npm-url]: https://npmjs.org/package/create-koa2-app
[downloads-image]: https://img.shields.io/npm/dm/create-koa2-app.svg
[downloads-url]: https://npmjs.org/package/create-koa2-app
[appveyor-image]: https://ci.appveyor.com/api/projects/status/7ka4hp27t43kkpo4?svg=true
[appveyor-url]: https://ci.appveyor.com/project/aandrewww/create-koa2-app-v09sd