https://github.com/chenlong-io/ts-koa-starter
typescript+koa起手式（简单的空环境）
https://github.com/chenlong-io/ts-koa-starter
koa2 nodemon pm2 typescript
Last synced: 6 months ago
JSON representation
typescript+koa起手式（简单的空环境）
- Host: GitHub
- URL: https://github.com/chenlong-io/ts-koa-starter
- Owner: chenlong-io
- Created: 2019-05-10T08:05:54.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-27T02:04:34.000Z (6 months ago)
- Last Synced: 2025-03-31T16:13:53.298Z (6 months ago)
- Topics: koa2, nodemon, pm2, typescript
- Language: TypeScript
- Homepage:
- Size: 19.5 KB
- Stars: 129
- Watchers: 2
- Forks: 48
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
本人平常喜欢用`nodejs`瞎 JB 写写东西，但是每次都要创建项目、安装依赖等等前戏工作，这让我很烦。于是乎写了个空的起手式，这样以后写东西直接 clone 下来就行了。
我觉得跟我一样的人应该很多，所以也把这个小东西分享给大家。
# ts-koa-starter
这是一个`koa`+`typescript`的起手式(简单的空环境)
注意：node 版本请在 v18 以上
如果你想再加个`typeorm`来玩玩数据库，请 clone 下来后切换到`bt-ts-koa-typeorm`分支
ps:`typeorm`是一个非常好的数据库 ORM，如果你没玩过，请务必尝试一下 💪💪💪
## 项目结构
```
.
├── src
│ ├── controller //controller层
│ ├── service //service层
│ ├── routes.ts //路由
│ └── index.ts //项目入口index.js
├── ecosystem.config.js //pm2配置
├── nodemon.json //nodemon配置
├── package.json
└── tsconfig.json
```
## 使用
- git clone https://github.com/chenlong-io/ts-koa-starter.git
- yarn 或者 npm i
- yarn start 或 npm start
- 在浏览器中开打`localhost:3000`
### 打包
- yarn build 或 npm run build
### 生产环境启动
- 生产环境使用 pm2 启动 可以达到负载均衡 执行：yarn pro 或 npm run pro （生产环境端口默认：8080）
## 友情链接
- Koa2 [Koa (koajs) -- 基于 Node.js 平台的下一代 web 开发框架 \| Koajs 中文文档](https://koa.bootcss.com/)
- Typescript [TypeScript 中文网 · TypeScript——JavaScript 的超集](https://www.tslang.cn/)