201 lines
6.5 KiB
Markdown
201 lines
6.5 KiB
Markdown
# 文件清单
|
|
|
|
## 项目结构
|
|
|
|
```
|
|
e-scooter-rental-system/
|
|
├── server/ # 后端代码
|
|
│ ├── models/ # 数据模型
|
|
│ │ ├── Vehicle.js # 车辆模型
|
|
│ │ ├── Order.js # 订单模型
|
|
│ │ ├── Customer.js # 客户模型
|
|
│ │ └── index.js # 模型导出
|
|
│ ├── routes/ # 路由
|
|
│ │ ├── vehicles.js # 车辆路由
|
|
│ │ ├── orders.js # 订单路由
|
|
│ │ ├── customers.js # 客户路由
|
|
│ │ ├── finance.js # 财务路由
|
|
│ │ └── index.js # 路由导出
|
|
│ ├── middleware/ # 中间件
|
|
│ │ └── errorHandler.js # 错误处理
|
|
│ ├── seed.js # 测试数据脚本
|
|
│ └── index.js # 入口文件
|
|
├── docs/ # 文档
|
|
│ ├── API.md # API 文档
|
|
│ ├── 数据库设计.md # 数据库设计
|
|
│ ├── 开发计划.md # 开发计划
|
|
│ ├── 快速开始.md # 快速开始指南
|
|
│ ├── 测试数据.md # 测试数据说明
|
|
│ ├── MongoDB安装指南.md # MongoDB 安装指南
|
|
│ ├── README.md # 项目说明
|
|
│ ├── 开发进度.md # 开发进度
|
|
│ ├── 下一步行动.md # 下一步行动
|
|
│ ├── 项目总结.md # 项目总结
|
|
│ ├── 文件清单.md # 文件清单
|
|
│ ├── 常见问题.md # 常见问题
|
|
│ ├── 项目里程碑.md # 项目里程碑
|
|
│ ├── 项目状态.md # 项目状态
|
|
│ ├── 项目完成清单.md # 项目完成清单
|
|
│ ├── 前端开发指南.md # 前端开发指南
|
|
│ └── 页面设计.md # 页面设计
|
|
├── .env # 环境配置
|
|
├── .gitignore # Git 忽略文件
|
|
├── package.json # 项目配置
|
|
└── README.md # 项目说明
|
|
```
|
|
|
|
## 代码文件 (15个)
|
|
|
|
### 数据模型 (4个)
|
|
1. `server/models/Vehicle.js` - 车辆模型
|
|
2. `server/models/Order.js` - 订单模型
|
|
3. `server/models/Customer.js` - 客户模型
|
|
4. `server/models/index.js` - 模型导出
|
|
|
|
### 路由 (5个)
|
|
5. `server/routes/vehicles.js` - 车辆路由
|
|
6. `server/routes/orders.js` - 订单路由
|
|
7. `server/routes/customers.js` - 客户路由
|
|
8. `server/routes/finance.js` - 财务路由
|
|
9. `server/routes/index.js` - 路由导出
|
|
|
|
### 中间件 (1个)
|
|
10. `server/middleware/errorHandler.js` - 错误处理
|
|
|
|
### 入口文件 (1个)
|
|
11. `server/index.js` - 入口文件
|
|
|
|
### 工具脚本 (1个)
|
|
12. `server/seed.js` - 测试数据脚本
|
|
|
|
### 配置文件 (3个)
|
|
13. `.env` - 环境配置
|
|
14. `.gitignore` - Git 忽略文件
|
|
15. `package.json` - 项目配置
|
|
|
|
## 文档文件 (16个)
|
|
|
|
### 项目文档 (16个)
|
|
1. `docs/API.md` - API 接口文档
|
|
2. `docs/数据库设计.md` - 数据库设计文档
|
|
3. `docs/开发计划.md` - 开发计划文档
|
|
4. `docs/快速开始.md` - 快速开始指南
|
|
5. `docs/测试数据.md` - 测试数据说明
|
|
6. `docs/MongoDB安装指南.md` - MongoDB 安装指南
|
|
7. `docs/README.md` - 项目说明文档
|
|
8. `docs/开发进度.md` - 开发进度文档
|
|
9. `docs/下一步行动.md` - 下一步行动文档
|
|
10. `docs/项目总结.md` - 项目总结文档
|
|
11. `docs/文件清单.md` - 文件清单文档
|
|
12. `docs/常见问题.md` - 常见问题文档
|
|
13. `docs/项目里程碑.md` - 项目里程碑文档
|
|
14. `docs/项目状态.md` - 项目状态文档
|
|
15. `docs/项目完成清单.md` - 项目完成清单文档
|
|
16. `docs/前端开发指南.md` - 前端开发指南
|
|
17. `docs/页面设计.md` - 页面设计文档
|
|
|
|
## 统计信息
|
|
|
|
### 文件总数
|
|
- 代码文件: 15 个
|
|
- 文档文件: 17 个
|
|
- 配置文件: 3 个
|
|
- **总计: 35 个文件** (不含 node_modules)
|
|
|
|
### API 接口统计
|
|
- 车辆管理: 7 个接口
|
|
- 订单管理: 7 个接口
|
|
- 客户管理: 7 个接口
|
|
- 财务管理: 3 个接口
|
|
- **总计: 24 个接口**
|
|
|
|
### 文档统计
|
|
- 项目文档: 17 个
|
|
- 涵盖: 安装、开发、测试、部署、前端开发全流程
|
|
|
|
## 文件说明
|
|
|
|
### 核心代码文件
|
|
|
|
#### 数据模型
|
|
- **Vehicle.js**: 车辆信息、状态、位置、维护记录
|
|
- **Order.js**: 订单号、客户、车辆、租期、费用、状态
|
|
- **Customer.js**: 客户信息、信用评分、租赁历史
|
|
|
|
#### 路由文件
|
|
- **vehicles.js**: 车辆管理接口 (7个)
|
|
- **orders.js**: 订单管理接口 (7个)
|
|
- **customers.js**: 客户管理接口 (7个)
|
|
- **finance.js**: 财务管理接口 (3个)
|
|
|
|
#### 中间件
|
|
- **errorHandler.js**: 统一错误处理
|
|
|
|
### 文档文件
|
|
|
|
#### 安装部署
|
|
- **MongoDB安装指南.md**: MongoDB 安装步骤
|
|
- **快速开始.md**: 项目快速启动指南
|
|
|
|
#### 开发文档
|
|
- **API.md**: 所有 API 接口说明
|
|
- **数据库设计.md**: 数据库表结构设计
|
|
- **开发计划.md**: 项目开发时间线
|
|
- **前端开发指南.md**: 前端开发规范
|
|
- **页面设计.md**: 页面布局和组件设计
|
|
|
|
#### 项目管理
|
|
- **开发进度.md**: 当前开发进度
|
|
- **下一步行动.md**: 待办事项清单
|
|
- **项目总结.md**: 项目概述和总结
|
|
- **项目状态.md**: 项目当前状态
|
|
- **项目里程碑.md**: 项目里程碑节点
|
|
- **项目完成清单.md**: 完成事项清单
|
|
|
|
#### 维护文档
|
|
- **常见问题.md**: 常见问题和解决方案
|
|
- **文件清单.md**: 项目文件清单
|
|
|
|
## 文件依赖关系
|
|
|
|
### 代码文件依赖
|
|
```
|
|
server/index.js
|
|
├── server/models/index.js
|
|
│ ├── server/models/Vehicle.js
|
|
│ ├── server/models/Order.js
|
|
│ └── server/models/Customer.js
|
|
├── server/routes/index.js
|
|
│ ├── server/routes/vehicles.js
|
|
│ ├── server/routes/orders.js
|
|
│ ├── server/routes/customers.js
|
|
│ └── server/routes/finance.js
|
|
└── server/middleware/errorHandler.js
|
|
```
|
|
|
|
### 文档文件依赖
|
|
```
|
|
README.md (项目入口)
|
|
├── 快速开始.md (启动指南)
|
|
├── MongoDB安装指南.md (数据库安装)
|
|
├── API.md (接口文档)
|
|
├── 开发计划.md (开发路线)
|
|
└── 前端开发指南.md (前端开发)
|
|
```
|
|
|
|
## 更新记录
|
|
|
|
### 2026-03-05
|
|
- 新增: 前端开发指南.md
|
|
- 新增: 页面设计.md
|
|
- 更新: 文件清单.md (增加前端文档)
|
|
- 更新: USER.md (增加文档引用)
|
|
|
|
## 下一步
|
|
|
|
1. 安装 MongoDB (首要任务)
|
|
2. 生成测试数据
|
|
3. 测试 API 接口
|
|
4. 创建前端项目
|
|
5. 实现页面设计
|