# koa-starter-kit

**Repository Path**: hzerica/koa-starter-kit

## Basic Information

- **Project Name**: koa-starter-kit
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 3
- **Created**: 2016-08-11
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 示范工程

## 注意事项

windows开发者,需要将mysql的lower_case_table_names改为0

## migrates

migrates文件夹下存放所有的数据库升级脚本。脚本的命名需以数字开头,且此数字不能重复。

假设开始数据库是纯空的, 所有脚本会依顺序执行。

当下次执行升级命令时,已经执行过的脚本不会再被执行,而未执行过的脚本则会继续依序执行。

也就是说,一旦一个migrate脚本被发布,它就不应该再被修改了(因为修改脚本本身不会影响到
服务器), 你需要编写新的脚本来修改数据库结构。

## models

models是自动生成的,不应被上传到git。在开发模式下,每次启动服务器都会重新生成所有文件。

## modules

modules文件夹下存放一些公用的逻辑模块,譬如文件存储、验证码发送、token检测等等。

## routers

实际API处理的模块依据API路径在`src/routers`下划分,并在`src/router.js`中被引用。

## 配置文件

配置文件应放在`config`文件夹下,并区分开发模式和发布模式。

## typechecker

所有客户端上传的参数都应当被检查。服务端应定义好不同类型的检查规则。检查时可以选择
每个参数所使用的checker并决定每个参数是否required。