# koa2-all-cli

**Repository Path**: liurb-public/koa2-all-cli

## Basic Information

- **Project Name**: koa2-all-cli
- **Description**: koa2 code scaffold
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-07-10
- **Last Updated**: 2022-06-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# koa2-all-cli
code scaffold for `koa@2` , contains orm framework that can auto-generated models、schema and service
## Usage
1、 clone this repository<br>
``` 
git clone https://github.com/lrbmike/koa2-all-cli.git
cd koa2-all-cli
npm install
``` 
2、 modify your db setting<br>
``` 
vim ./config/db.json
``` 
3、 run<br>
 ``` 
node ./bin/koa2cli.js -t your_table_name
or
node ./bin/koa2cli.js -f your_web-project_name
or
node ./bin/koa2cli.js -a your_api-project_name

Options:
-t, --tables [tables]  generate tables, multiple use "##"
-f, --framework [name]  generate koa2 web framework, input your project name
-a, --api [name]  generate koa2 api framework, input your project name
-i, --include [tables] generate framework and include input tables, multiple use "##"
--prefix [prefix]      table prefix
 ``` 
the code will create in the `output` directory

## Project

* **db setting**

you need to modify your db setting `db.json`, the file is in the `config` directory<br>

* **redis setting**

if you want to use redis service(default create), you need to modify your redis setting `redis.json`, the file is in the `config` directory<br>

or you can delete this file, and delete `RedisService.js`, the file is in the `service` directory<br>