Skip to content

zhangyiabc/koa-ts-server

Repository files navigation

Koa + TS + Mysql + Log4Js

本项目利用koa框架 mysql数据库 ts 以及Log4js记录日志 apidoc生成文档

命令说明

npm run dev

生成接口文档,并启动nodemon监听文件改变

npm run build

将ts代码编译成js

npm run start:dist

运行dist中的文件

npm run lint

代码检查

npm run doc

生成接口文档

生成接口注释写法

若想查看更多写法, 请参考apidoc文档https://apidocjs.com/

koa-ts-server
├─ .eslintignore // eslint相关
├─ .eslintrc.js  // eslint相关
├─ .gitignore
├─ .prettierrc
├─ .prettierrc.js
├─ .husky  husk 配置
├─ apidoc.json // 接口文档配置
├─ nodemon.json // nodemon配置
├─ package-lock.json
├─ package.json
├─ path.tsconfig.json
├─ README.md
├─ src
│  ├─ index.ts
│  ├─ logs // 日志文件
│  ├─ middlewares // 中间件
│  ├─ models 
│  ├─ routers
│  ├─ services
│  ├─ test
│  ├─ config // 配置
├─ tsconfig-paths-bootstrap.js
└─ tsconfig.json

日志文件存放, logs/* 五天删除一次 最大字节数1024 * 50

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published