这是一个基于 Express + TypeScript + ORM
构建的项目基础模板。该模板使用分层架构,包括 controller
、service
、model
等层,方便项目的扩展和维护。
- Express:基于 Node.js 的快速 Web 框架。
- TypeScript:增强代码的类型安全。
- ORM:支持与数据库的对象关系映射,简化数据库操作。
- 分层架构:清晰分离业务逻辑、数据模型和控制器逻辑,方便项目扩展。
- JWT 身份验证:内置身份验证中间件 🔐。
- Swagger:生成接口文档,方便 API 文档化 📖。
- 定时任务:支持定时任务功能 ⏰。
- 环境配置:集中管理项目配置和环境变量 ⚙️。
git clone https://github.com/coder-belong/study_express.git
cd my-project2 1git clone https://github.com/coder-belong/study_express.git2cd my-projectbash
npm install
在开发模式下启动项目:
npm run dev
如果需要使用 PM2 部署生产环境,可以运行以下命令:
pm2 start ecosystem.config.js
config/
- 配置文件,集中管理项目的各种配置 📂。src/controller/
- 控制器层,负责处理 HTTP 请求 🌐。src/middleware/
- 中间件文件,用于处理请求过程中的通用逻辑(如身份验证) 🛡️。src/models/
- 数据模型层,定义数据结构和数据库表结构 📊。src/service/
- 业务逻辑层,封装具体的业务逻辑 🔧。src/utils/
- 工具函数库,包含一些通用功能 🛠️。src/schedule/
- 定时任务的相关代码 ⏲️。
- JWT 身份验证:
authMiddleware.ts
提供用户鉴权功能 🔑。 - 数据库连接:
database.ts
中定义数据库连接配置 🔗。 - 工具函数:
utils/
目录包含 JWT 操作、密码加密等工具函数 🔒。 - 接口文档:
swagger.ts
用于配置 Swagger,生成接口文档 📝。
欢迎提交 Pull Request 或 Issues。如果你有任何问题或建议,欢迎与我们联系 💬。