示例项目:待办事项应用
本示例展示前后端开发项目的完整结构和文档模板
项目概述
项目名称:TodoApp - 待办事项管理应用
目标:开发一个简洁的待办事项管理应用,支持任务创建、编辑、删除、分类管理。
技术栈:
- 前端:React + TypeScript
- 后端:FastAPI + PostgreSQL
- 部署:Docker
项目结构
todoapp/
├── frontend/ # 前端项目
│ ├── src/
│ │ ├── components/ # 组件
│ │ ├── pages/ # 页面
│ │ ├── api/ # API调用
│ │ ├── utils/ # 工具函数
│ │ └── styles/ # 样式
│ ├── public/
│ ├── package.json
│ └── README.md
├── backend/ # 后端项目
│ ├── src/
│ │ ├── api/ # API路由
│ │ ├── models/ # 数据模型
│ │ ├── services/ # 业务逻辑
│ │ ├── utils/ # 工具函数
│ │ └── config/ # 配置
│ ├── tests/
│ ├── requirements.txt
│ └── README.md
├── docs/
│ ├── api.md # API文档
│ ├── database_design.md # 数据库设计
│ └── tasks.md # 任务清单
├── docker-compose.yml
└── README.md
运行方式
# 启动数据库和后端
docker-compose up -d
# 前端开发
cd frontend
npm install
npm run dev
# 后端开发
cd backend
pip install -r requirements.txt
uvicorn src.main:app --reload
时间线
| 阶段 | 时间 | 交付物 |
|---|---|---|
| API与数据库设计 | Week 1 | API文档、数据库设计 |
| 后端开发 | Week 2-3 | 核心API完成 |
| 前端开发 | Week 3-4 | 核心页面完成 |
| 联调测试 | Week 5 | 全功能可用 |