Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/17koa/koa-generator
Koa' application generator for 1.x and 2.x（ Express-style and support all middlewares include async/await ）
https://github.com/17koa/koa-generator
koa koa-generator koa-starter koa2 nodejs scaffold web
Last synced: 19 days ago
JSON representation
Koa' application generator for 1.x and 2.x（ Express-style and support all middlewares include async/await ）
- Host: GitHub
- URL: https://github.com/17koa/koa-generator
- Owner: i5ting
- License: mit
- Created: 2015-12-04T16:11:25.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-02-07T23:57:27.000Z (over 1 year ago)
- Last Synced: 2024-08-23T18:17:55.594Z (24 days ago)
- Topics: koa, koa-generator, koa-starter, koa2, nodejs, scaffold, web
- Language: JavaScript
- Homepage: https://github.com/17koa/koa-generator
- Size: 190 KB
- Stars: 972
- Watchers: 42
- Forks: 110
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# koa-generator
http://koajs.com/
[Koa](https://www.npmjs.com/package/koa) application generator.
[![NPM Version][npm-image]][npm-url]
[![NPM Downloads][downloads-image]][downloads-url]
## Features
- Express-style
- Support koa 1.x（supported）
- Support koa 2.x（koa middleware supported,need Node.js 7.6+ ,babel optional）
## Installation
```sh
$ npm install -g koa-generator
```
with 2 commands
- koa (Support koa 1.x)
- koa2 (Support koa 2.x)
## Quick Start 1.x
The quickest way to get started with koa is to utilize the executable `koa(1)` to generate an application as shown below:
Create the app:
```bash
$ koa
```
Install dependencies:
```bash
$ npm install
```
Rock and Roll
```bash
$ npm start
```
## Quick Start 2.x
The quickest way to get started with koa is to utilize the executable `koa2(1)` to generate an application as shown below:
Create the app:
```bash
$ koa2 /tmp/foo && cd /tmp/foo
```
Install dependencies:
```bash
$ npm install
```
Rock and Roll
```bash
$ npm start
```
more detail see [koa2-demo](https://github.com/17koa/koa2-demo)
## 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
-e, --ejs add ejs engine support (defaults to jade)
--hbs add handlebars engine support
-n, --nunjucks add nunjucks engine support
-H, --hogan add hogan.js engine support
-c, --css add stylesheet support (less|stylus|compass|sass) (defaults to plain css)
--git add .gitignore
-f, --force force on non-empty directory
目前选项-c还没有实现
## Git Branch Details
- master = koa generator
- tpl = koa 1.x template
- tpl_2.x = koa 2.x template
## License
[MIT](LICENSE)
[npm-image]: https://img.shields.io/npm/v/koa-generator.svg
[npm-url]: https://npmjs.org/package/koa-generator
[downloads-image]: https://img.shields.io/npm/dm/koa-generator.svg
[downloads-url]: https://npmjs.org/package/koa-generator