feat: 初始化项目

This commit is contained in:
richarjiang
2025-08-13 15:17:33 +08:00
commit 4f9d648a50
72 changed files with 29051 additions and 0 deletions

View File

@@ -0,0 +1,19 @@
---
description:
globs:
alwaysApply: false
---
# API文档 (Swagger)
本项目使用Swagger自动生成API文档。
## 配置
- Swagger配置位于[src/main.ts](mdc:src/main.ts)文件中
- API文档在项目运行时可通过 `/api/docs` 路径访问
## API架构
- 所有API路由都有 `/api` 前缀
- API请求和响应使用DTO数据传输对象定义
- 主要API组:
- 用户API: `/api/users` - 由[src/users/users.controller.ts](mdc:src/users/users.controller.ts)处理
- 任务API: `/api/tasks` - 由[src/tasks/task.controller.ts](mdc:src/tasks/task.controller.ts)处理

View File

@@ -0,0 +1,20 @@
---
description:
globs:
alwaysApply: false
---
# 数据库模块 (Database Module)
数据库模块负责配置和管理与MySQL数据库的连接使用Sequelize ORM。
## 主要文件
- 模块定义: [src/database/database.module.ts](mdc:src/database/database.module.ts) - 配置Sequelize连接
## 使用说明
- 该模块通过NestJS的ConfigService从环境变量获取数据库配置
- 支持的环境变量:
- DB_HOST: 数据库主机
- DB_PORT: 数据库端口
- DB_USERNAME: 数据库用户名
- DB_PASSWORD: 数据库密码
- DB_DATABASE: 数据库名称

View File

@@ -0,0 +1,25 @@
---
description:
globs:
alwaysApply: false
---
# 部署与运行指南
本项目支持多种运行和部署方式,包括开发环境和生产环境。
## 脚本
- 开发环境启动: `yarn start:dev` 或 `npm run start:dev` - 带有热重载功能
- 生产环境构建: `yarn build` 或 `npm run build`
- 生产环境启动: `yarn start:prod` 或 `npm run start:prod`
## PM2部署
项目支持使用PM2进行部署和进程管理:
- PM2配置文件: [ecosystem.config.js](mdc:ecosystem.config.js)
- 启动命令:
- 生产环境: `yarn pm2:start` 或 `npm run pm2:start`
- 开发环境: `yarn pm2:start:dev` 或 `npm run pm2:start:dev`
## Shell脚本
项目包含两个启动脚本:
- [start-dev.sh](mdc:start-dev.sh) - 开发环境启动脚本
- [start.sh](mdc:start.sh) - 生产环境启动脚本

View File

@@ -0,0 +1,22 @@
---
description:
globs:
alwaysApply: false
---
# Love Tips Server - 项目结构
这是一个基于NestJS框架的服务端项目提供了Love Tips应用的后端API服务。
## 主要入口文件
- 主入口点: [src/main.ts](mdc:src/main.ts) - 启动NestJS应用程序
- 主模块: [src/app.module.ts](mdc:src/app.module.ts) - 应用的根模块,引入所有其他模块
## 核心模块
- 数据库模块: [src/database/database.module.ts](mdc:src/database/database.module.ts) - 使用Sequelize连接MySQL数据库
- 用户模块: [src/users/users.module.ts](mdc:src/users/users.module.ts) - 处理用户相关功能
- 任务模块: [src/tasks/task.module.ts](mdc:src/tasks/task.module.ts) - 处理任务相关功能
## 项目配置文件
- [package.json](mdc:package.json) - 项目依赖和脚本配置
- [tsconfig.json](mdc:tsconfig.json) - TypeScript配置
- [ecosystem.config.js](mdc:ecosystem.config.js) - PM2配置文件用于生产环境部署

View File

@@ -0,0 +1,17 @@
---
description:
globs:
alwaysApply: false
---
# 任务模块 (Tasks Module)
任务模块处理所有与任务相关的功能,可能包括定时任务、队列任务或用户任务。
## 主要文件
- 模块定义: [src/tasks/task.module.ts](mdc:src/tasks/task.module.ts)
- 控制器: [src/tasks/task.controller.ts](mdc:src/tasks/task.controller.ts) - 处理HTTP请求
- 服务: [src/tasks/task.service.ts](mdc:src/tasks/task.service.ts) - 包含业务逻辑
## 子目录
- DTO目录: `src/tasks/dto/` - 包含数据传输对象
- 模型目录: `src/tasks/models/` - 包含数据库模型

View File

@@ -0,0 +1,18 @@
---
description:
globs:
alwaysApply: false
---
# 用户模块 (Users Module)
用户模块处理用户相关的所有功能,包括注册、登录和用户信息管理。
## 主要文件
- 模块定义: [src/users/users.module.ts](mdc:src/users/users.module.ts)
- 控制器: [src/users/users.controller.ts](mdc:src/users/users.controller.ts) - 处理HTTP请求
- 服务: [src/users/users.service.ts](mdc:src/users/users.service.ts) - 包含业务逻辑
## 子目录
- DTO目录: `src/users/dto/` - 包含数据传输对象
- 模型目录: `src/users/models/` - 包含数据库模型
- 服务目录: `src/users/services/` - 包含额外的服务类