- 创建 monorepo 结构(Turborepo) - 初始化前端项目(Next.js + TypeScript + Tailwind CSS) - 初始化后端项目(NestJS + TypeScript) - 配置开发工具(ESLint, Prettier, VS Code) - 创建项目文档(README, 开发规范) Closes #1
107 lines
3.6 KiB
Markdown
107 lines
3.6 KiB
Markdown
# 项目需求文档
|
||
|
||
**项目名称**: TaskManager
|
||
**创建时间**: 2026-03-19 15:49:18
|
||
**项目类型**: Web 应用(前端 + 后端)
|
||
|
||
## 项目描述
|
||
|
||
任务管理器 - 一个用于创建、管理和组织任务的 Web 应用系统。支持任务的完整生命周期管理,包括创建、编辑、状态管理和归档功能。
|
||
|
||
## 核心功能
|
||
|
||
1. **创建任务** - 用户可以创建新任务,填写任务名称、描述等信息
|
||
2. **编辑任务** - 修改任务的各项属性和信息
|
||
3. **删除任务** - 移除不再需要的任务
|
||
4. **修改任务状态** - 更新任务的完成状态(待办/进行中/已完成等)
|
||
5. **归档任务** - 将已完成或不再活跃的任务归档保存
|
||
6. **标签任务** - 为任务添加标签以便分类和筛选
|
||
|
||
## 技术栈
|
||
|
||
### 编程语言
|
||
- TypeScript
|
||
|
||
### 框架
|
||
- **前端**: Next.js(React 全栈框架)
|
||
- **后端**: NestJS(企业级 Node.js 框架)
|
||
|
||
### 数据库
|
||
- SQLite(嵌入式关系型数据库)
|
||
|
||
### 其他工具
|
||
- **认证**: 需要用户认证功能
|
||
- **API 文档**: 需要(Swagger/OpenAPI 自动生成)
|
||
- **测试框架**: 待定
|
||
|
||
## 依赖关系
|
||
|
||
```
|
||
┌─────────────────────────────────────────────┐
|
||
│ TaskManager 应用 │
|
||
├─────────────────┬───────────────────────────┤
|
||
│ Next.js 前端 │ NestJS 后端 │
|
||
│ (React SSR) │ (RESTful API) │
|
||
├─────────────────┴───────────────────────────┤
|
||
│ SQLite 数据库 │
|
||
├─────────────────────────────────────────────┤
|
||
│ 认证系统 + API 文档 │
|
||
└─────────────────────────────────────────────┘
|
||
```
|
||
|
||
## 项目结构建议
|
||
|
||
```
|
||
taskmanager/
|
||
├── frontend/ # Next.js 前端项目
|
||
│ ├── app/ # App Router 路由
|
||
│ ├── components/ # React 组件
|
||
│ └── lib/ # 前端工具库
|
||
├── backend/ # NestJS 后端项目
|
||
│ ├── src/
|
||
│ │ ├── modules/ # 功能模块
|
||
│ │ ├── common/ # 公共代码
|
||
│ │ └── config/ # 配置文件
|
||
│ └── test/ # 测试文件
|
||
├── docs/ # 项目文档
|
||
│ ├── plan/ # 开发计划
|
||
│ └── modules/ # 模块文档
|
||
├── CLAUDE.md # 开发规范
|
||
└── README.md # 项目说明
|
||
```
|
||
|
||
## 开发阶段建议
|
||
|
||
### 阶段一:基础架构搭建
|
||
- 初始化 Next.js 前端项目
|
||
- 初始化 NestJS 后端项目
|
||
- 配置 SQLite 数据库连接
|
||
- 配置 TypeScript 编译环境
|
||
|
||
### 阶段二:认证系统实现
|
||
- 实现用户注册/登录
|
||
- JWT Token 认证机制
|
||
- 路由权限保护
|
||
|
||
### 阶段三:核心功能开发
|
||
- 任务 CRUD 操作
|
||
- 任务状态管理
|
||
- 标签系统
|
||
- 归档功能
|
||
|
||
### 阶段四:API 文档与测试
|
||
- 集成 Swagger 文档
|
||
- 编写单元测试
|
||
- 编写集成测试
|
||
|
||
## 备注
|
||
|
||
- 项目采用前后端分离架构,前端使用 Next.js,后端使用 NestJS
|
||
- 数据库选择 SQLite 便于快速开发和部署
|
||
- 需要特别注意前后端的 API 接口设计和数据交互
|
||
- 建议使用 monorepo 结构管理前后端代码
|
||
|
||
---
|
||
|
||
**下一步操作**: 使用 `/gitea-init-project` 初始化项目并创建 Gitea Issues
|