https://github.com/eightfeet/dwxopen
https://github.com/eightfeet/dwxopen
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/eightfeet/dwxopen
- Owner: eightfeet
- License: mit
- Created: 2025-04-10T15:57:56.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-04-12T14:34:59.000Z (6 months ago)
- Last Synced: 2025-04-12T15:32:25.674Z (6 months ago)
- Language: TypeScript
- Size: 0 Bytes
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Express TypeScript Template
快速创建使用 TypeScript 编写的 Express 项目
- 使用 TypeScript 进行代码编写，ts 代码请于 src 中进行编写，执行 `npm run build` 后，编译后的代码将存放于 dist 目录。
- git 提交规范使用 [cz-cli](https://github.com/commitizen/cz-cli) 因此提交代码时，请执行 `npm run commit`。
- 测试框架使用 Jest，运行 `npm run test` 后，报告将存放在 coverage 目录中。
- 使用 ESLint 作为代码检测工具
- 使用 prettier 美化代码格式，推荐使用 VSCode 进行开发，并下载 Prettier 扩展，代码在保存的时候将自动进行格式化。
- 使用 husky 配置 git 钩子，在提交的时候，将使用 ESLint 进行代码语法检测以及使用 Jest 执行代码测试。
## How to use
### Development
由于项目是使用 TypeScript 进行开发，因此需要运行时需要先将 TypeScript 编译成 JavaScript，通过执行下面的命令，监听 src 目录下的代码变化，自动将代码编译成 JavaScript。
```bash
npm run dev:build
```
当代码已经转换为 JavaScript 后，运行下面的命令来跑项目。
```bash
npm run dev:serve
```
该命令使用 nodemon 监听 dist 目录的代码变化。当在不同的终端运行 `npm run dev` 以及 `npm run server` 的时候，如果 src 目录下的代码发生变化，会造成 dist 目录下的代码发生变化。dist 目录下的代码发生变化会触发 nodemon 重新运行项目，从而来确保当前运行的代码是最新的代码。
### Production
执行下面的命令，会将 src 中的所有代码编译输出到 dist 目录中
```bash
npm run prd:build
```
### Code commit
Git 代码提交使用 commitizen 进行规范，因此提交代码的时候请运行：
```bash
npm run commit
```
## Tips
编辑器推荐使用 Visual Studio Code。
为了更好的开发体验，请安装一下 VS Code 插件：
- ESLint
- Jest
- Prettier - Code formatter
- EditorConfig for VS Code
node 用的18版本
服务器用的caddy
启动caddy start
curl localhost:2019/load -H "Content-Type: application/json" -d @caddy.json
启动node