143 lines
4.0 KiB
Markdown
143 lines
4.0 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/ # 文档
|
|
│ ├── README.md # 项目说明
|
|
│ ├── API.md # API 文档
|
|
│ ├── 数据库设计.md # 数据库设计
|
|
│ ├── 开发计划.md # 开发计划
|
|
│ ├── 快速开始.md # 快速开始指南
|
|
│ ├── 测试数据.md # 测试数据说明
|
|
│ ├── MongoDB安装指南.md # MongoDB 安装指南
|
|
│ ├── 开发进度.md # 开发进度
|
|
│ ├── 下一步行动.md # 下一步行动
|
|
│ ├── 项目总结.md # 项目总结
|
|
│ ├── 文件清单.md # 文件清单
|
|
│ ├── 常见问题.md # 常见问题
|
|
│ ├── 项目里程碑.md # 项目里程碑
|
|
│ └── 项目状态.md # 项目状态
|
|
├── .env # 环境配置
|
|
├── .gitignore
|
|
└── package.json
|
|
```
|
|
|
|
## 🛠️ 技术栈
|
|
|
|
- **后端**: Node.js + Express + MongoDB
|
|
- **前端**: Vue.js / React (待定)
|
|
- **数据库**: MongoDB
|
|
|
|
## 📋 功能模块
|
|
|
|
1. **车辆管理** - 车辆信息、状态追踪、GPS定位
|
|
2. **订单管理** - 租赁订单、计费、逾期提醒
|
|
3. **客户管理** - 客户信息、租赁历史
|
|
4. **财务管理** - 收入统计、报表生成
|
|
5. **运维管理** - 维修记录、保养提醒
|
|
|
|
## 🚀 快速开始
|
|
|
|
### 1. 安装 MongoDB
|
|
详细步骤请查看: [MongoDB安装指南.md](MongoDB安装指南.md)
|
|
|
|
### 2. 启动后端服务
|
|
```bash
|
|
cd E:\code\e-scooter-rental-system
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
### 3. 生成测试数据
|
|
```bash
|
|
npm run seed
|
|
```
|
|
|
|
### 4. 测试 API
|
|
访问: http://localhost:3000/health
|
|
|
|
## 📖 文档导航
|
|
|
|
- [API 文档](API.md) - 接口说明
|
|
- [数据库设计](数据库设计.md) - 数据模型设计
|
|
- [开发计划](开发计划.md) - 项目开发计划
|
|
- [快速开始](快速开始.md) - 快速上手指南
|
|
- [测试数据](测试数据.md) - 测试数据说明
|
|
- [MongoDB安装指南](MongoDB安装指南.md) - 数据库安装步骤
|
|
- [项目状态](项目状态.md) - 当前状态
|
|
|
|
## 🎯 功能优先级
|
|
|
|
### P0 (必须实现)
|
|
1. 车辆信息管理 (增删改查)
|
|
2. 订单创建和管理
|
|
3. 客户信息管理
|
|
4. 订单状态流转
|
|
5. 财务统计
|
|
|
|
### P1 (重要功能)
|
|
1. 车辆位置追踪
|
|
2. 逾期订单提醒
|
|
3. 客户信用评分
|
|
4. 数据搜索和筛选
|
|
|
|
### P2 (锦上添花)
|
|
1. 数据导出 (Excel)
|
|
2. 报表图表展示
|
|
3. 短信通知
|
|
4. 移动端适配
|
|
|
|
## 📝 开发规范
|
|
|
|
### 代码规范
|
|
- 使用 ESLint 代码检查
|
|
- 统一代码风格
|
|
- 添加必要注释
|
|
|
|
### Git 规范
|
|
- 使用 feature 分支开发
|
|
- 提交信息格式: `类型: 描述`
|
|
- 定期合并到 main 分支
|
|
|
|
### API 规范
|
|
- 统一返回格式: `{ success, data, message }`
|
|
- 使用 HTTP 状态码
|
|
- 添加错误处理
|
|
|
|
## 🚀 当前状态
|
|
|
|
- ✅ 后端服务框架搭建完成
|
|
- ✅ 数据模型设计完成
|
|
- ✅ API 路由实现完成
|
|
- ✅ 文档编写完成
|
|
- ❌ MongoDB 未安装
|
|
- ⏳ 需要安装 MongoDB 数据库
|
|
- ⏳ 需要生成测试数据
|
|
- ⏳ 需要开发前端页面
|
|
|
|
## 📞 联系方式
|
|
|
|
如有问题，请联系项目负责人。
|