https://github.com/zhengxs2018/fullstack-app-template
一个完善的基于 koa.js 开发的全栈应用模板，可在生产项目中使用。
https://github.com/zhengxs2018/fullstack-app-template
fullstack koa koa2 nodejs swagger-ui templates
Last synced: about 1 month ago
JSON representation
一个完善的基于 koa.js 开发的全栈应用模板，可在生产项目中使用。
- Host: GitHub
- URL: https://github.com/zhengxs2018/fullstack-app-template
- Owner: zhengxs2018
- License: mit
- Archived: true
- Created: 2020-06-14T06:35:49.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-25T01:06:55.000Z (over 4 years ago)
- Last Synced: 2025-03-13T23:29:13.027Z (2 months ago)
- Topics: fullstack, koa, koa2, nodejs, swagger-ui, templates
- Language: TypeScript
- Size: 52.7 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fullstack-app-template
[](https://www.typescriptlang.org/)
[](https://github.com/prettier/prettier)
一个完善的基于 [koa.js][koa.js] 开发的全栈应用模板，可在生产项目中使用。
## 功能列表
- 由 [node-config](https://github.com/lorenwest/node-config) 支持不同环境配置
- 由 [dotenv](https://github.com/https://github.com/motdotla/dotenv) 支持环境变量管理
- 基于 [@koa/router][@koa/router] 构建的蓝图功能
- 使用 [swagger-ui][swagger-ui] 生成 api 文档
- 添加 [parameter](https://github.com/node-modules/parameter) 模块来支持表单验证
- 数据库默认是 `sqlite`，可以支持其他数据，如 `mysql`，由 [prisma2][prisma2] 驱动
- 支持 typescript 编写
- 支持应用分层写法
## 目录结构
```text
├── docs/
├── migrations/ # 数据库迁移脚本
├── run/
| ├── application_config.json # 应用运行时的配置信息
| └── application_config_meta.json # 应用运行时的配置的元数据
├── src/
| ├── setup.ts # 启动脚本
| ├── main.ts # 应用入口
| ├── config/ # 应用配置
| | ├── default.ts
| | ├── development.ts
| | └── production.ts
| ├── contract/
| | ├── request/ # 表单验证规则和输入字段定义
| | ├── response/ # 输出数据转换和安全字段拦截
| | └── *.yaml # swagger ui 定义文件
| ├── db/
| | └── client.ts # @prisma/client 实例对象
| ├── extend/
| | ├── application.ts
| | └── context.ts
| ├── shared/ # 公共代码
| ├── middleware/ # 中间件函数
| ├── modules/
| | ├── admin/ # 管理后台
| | | ├── static/ # 静态文件
| | | ├── templates/ # 模板文件
| | | └── main.ts # 模块入口
| | |
| | ├── api/ # 数据接口
| | | └── main.ts
| | |
| | ├── mobile/ # 移动端
| | | ├── static/ # 静态文件
| | | ├── templates/ # 模板文件
| | | └── main.ts # 模块入口
| | └── web/ # 官网
| | ├── static/ # 静态文件
| | ├── templates/ # 模板文件
| | └── main.ts # 模块入口
| └── service/ # 内部调用服务
├── .env # 环境配置文件
├── ecosystem.config.js # pm2 配置文件
├── tsconfig.json
├── schema.prisma # prisma 定义文件
└── README.md
```
## 文档
- [蓝图](./docs/blueprint.md)
- [表单验证](./docs/form-validate.md)
- [部署到服务器](./docs/deploy.md)
## 启动项目
> 注意: 请确保本地安装有 redis，或修改 redis 的主机地址，否则项目将无法启动。
你需要安装 Node.js 的版本为 12+，应用依赖 redis 服务。
克隆此仓库后运行:
``` bash
# 安装依赖
$ npm install
# 更新数据库
$ npm run db:up
# 启动开发模式
# 打开 http://127.0.0.1:8080/api/docs 可以查看 api 文档
$ npm run dev
# 启动调试模式，需要其他工具配合，如：vscode，Chrome devtools
$ npm run debug
```
更多 `npm version` 的命令可使用 `npm version --help` 查看
## 感谢
感谢以下开源项目给予的灵感和帮助，以下排名不分先后。
* [koa.js][koa.js]
* [@koa/router][@koa/router]
* [swagger-ui][swagger-ui]
* [prisma2][prisma2]
* [dotenv][dotenv]
* [parameter][parameter]
* [flask][flask]
* [nunjucks][nunjucks]
* And more.
## License
* MIT
[koa.js]: https://github.com/koajs/koa
[@koa/router]: https://github.com/koajs/router
[swagger-ui]: https://swagger.io/
[prisma2]: https://github.com/prisma/prisma
[node-config]: https://github.com/lorenwest/node-config
[dotenv]: https://github.com/https://github.com/motdotla/dotenv
[parameter]: https://github.com/node-modules/parameter
[flask]: https://github.com/pallets/flask
[nunjucks]: https://github.com/mozilla/nunjucks