重构认证系统和订单支付功能,新增邮箱验证、密码重置及支付流程
This commit is contained in:
86
README.md
86
README.md
@@ -1,7 +1,49 @@
|
||||
# 🏗️ 结伴客项目
|
||||
# 解班客 - 宠物认领平台
|
||||
|
||||
## 📋 项目概述
|
||||
结伴客是一个综合性的管理系统,包含后台管理、微信小程序和官方网站三个主要模块。
|
||||
一个基于Vue.js和Node.js的宠物认领平台,帮助流浪动物找到温暖的家。
|
||||
|
||||
## 项目概述
|
||||
|
||||
解班客是一个专业的宠物认领平台,致力于为流浪动物提供一个温暖的归宿。平台通过现代化的Web技术,为用户提供便捷的宠物发布、搜索、认领服务,同时为管理员提供完善的后台管理功能。
|
||||
|
||||
### 核心功能
|
||||
|
||||
- **用户系统**: 完整的用户注册、登录、个人信息管理
|
||||
- **动物管理**: 动物信息发布、编辑、状态管理
|
||||
- **认领流程**: 在线认领申请、审核、跟踪
|
||||
- **地图定位**: 基于地理位置的动物搜索和展示
|
||||
- **管理后台**: 用户管理、动物管理、数据统计、文件管理
|
||||
- **消息通知**: 实时消息推送和邮件通知
|
||||
- **数据统计**: 详细的业务数据分析和报表
|
||||
|
||||
## 技术架构
|
||||
|
||||
### 前端技术栈
|
||||
- **框架**: Vue.js 3.x + Composition API
|
||||
- **UI组件**: Element Plus
|
||||
- **状态管理**: Pinia
|
||||
- **路由**: Vue Router 4
|
||||
- **构建工具**: Vite
|
||||
- **HTTP客户端**: Axios
|
||||
- **样式**: SCSS + CSS Modules
|
||||
|
||||
### 后端技术栈
|
||||
- **运行时**: Node.js 18+
|
||||
- **框架**: Express.js
|
||||
- **数据库**: MySQL 8.0
|
||||
- **缓存**: Redis 6.0
|
||||
- **认证**: JWT + Passport
|
||||
- **文件处理**: Multer + Sharp
|
||||
- **日志**: Winston
|
||||
- **测试**: Jest + Supertest
|
||||
|
||||
### 基础设施
|
||||
- **容器化**: Docker + Docker Compose
|
||||
- **反向代理**: Nginx
|
||||
- **进程管理**: PM2
|
||||
- **监控**: Prometheus + Grafana
|
||||
- **日志收集**: ELK Stack
|
||||
- **CI/CD**: GitHub Actions
|
||||
|
||||
## 🗂️ 项目结构
|
||||
|
||||
@@ -55,6 +97,25 @@ cd website && npm run dev
|
||||
|
||||
所有详细文档位于 `docs/` 目录:
|
||||
|
||||
### 📖 快速导航
|
||||
|
||||
| 文档类型 | 文档名称 | 描述 | 适用人员 |
|
||||
|---------|---------|------|---------|
|
||||
| 🚀 快速开始 | [系统集成和部署文档](docs/系统集成和部署文档.md) | 环境搭建、部署流程 | 开发者、运维 |
|
||||
| 🔧 开发指南 | [前端开发文档](docs/前端开发文档.md) | 前端开发规范和指南 | 前端开发者 |
|
||||
| 🔧 开发指南 | [后端开发文档](docs/后端开发文档.md) | 后端开发规范和指南 | 后端开发者 |
|
||||
| 📋 API参考 | [API接口文档](docs/API接口文档.md) | 完整的API接口文档 | 全栈开发者 |
|
||||
| 🗄️ 数据设计 | [数据库设计文档](docs/数据库设计文档.md) | 数据库结构设计 | 后端开发者、DBA |
|
||||
| 👨💼 管理功能 | [管理员后台系统API文档](docs/管理员后台系统API文档.md) | 管理后台功能说明 | 管理员、开发者 |
|
||||
| 📁 文件系统 | [文件上传系统文档](docs/文件上传系统文档.md) | 文件上传和管理 | 全栈开发者 |
|
||||
| 🔍 监控运维 | [错误处理和日志系统文档](docs/错误处理和日志系统文档.md) | 错误处理和日志 | 开发者、运维 |
|
||||
| 🧪 质量保证 | [测试文档](docs/测试文档.md) | 测试策略、用例设计和质量保证 | 测试工程师、开发者 |
|
||||
| 🔒 安全管理 | [安全和权限管理文档](docs/安全和权限管理文档.md) | 安全策略、权限控制、安全防护措施 | 安全工程师、系统管理员 |
|
||||
| ⚡ 性能优化 | [性能优化文档](docs/性能优化文档.md) | 系统性能优化策略、监控方案和优化实践 | 性能工程师、运维工程师 |
|
||||
| 🚀 部署运维 | [部署和运维文档](docs/部署和运维文档.md) | 系统部署流程和运维管理方案 | 运维工程师、DevOps工程师 |
|
||||
| 📊 项目管理 | [项目开发进度报告](docs/项目开发进度报告.md) | 项目进度和规划 | 项目经理、开发者 |
|
||||
| 📝 开发规范 | [开发规范和最佳实践](docs/开发规范和最佳实践.md) | 代码规范和标准 | 全体开发者 |
|
||||
|
||||
### 核心文档
|
||||
- 📄 [项目概述](docs/项目概述.md) - 项目背景、目标和整体介绍
|
||||
- 📄 [系统架构文档](docs/系统架构文档.md) - 系统架构设计和技术栈
|
||||
@@ -63,6 +124,25 @@ cd website && npm run dev
|
||||
- 📄 [开发指南](docs/开发指南.md) - 开发环境搭建和开发规范
|
||||
- 📄 [部署指南](docs/部署指南.md) - 开发、测试、生产环境部署指南
|
||||
|
||||
### 功能模块文档
|
||||
|
||||
| 文档名称 | 描述 | 链接 |
|
||||
|---------|------|------|
|
||||
| API接口文档 | 详细的API接口说明和使用示例 | [查看文档](./docs/API接口文档.md) |
|
||||
| 管理员后台文档 | 管理员功能和操作指南 | [查看文档](./docs/管理员后台文档.md) |
|
||||
| 用户认证系统文档 | 用户注册、登录、权限管理 | [查看文档](./docs/用户认证系统文档.md) |
|
||||
| 动物管理系统文档 | 动物信息管理和认领流程 | [查看文档](./docs/动物管理系统文档.md) |
|
||||
| 文件上传系统文档 | 文件上传、存储和管理 | [查看文档](./docs/文件上传系统文档.md) |
|
||||
| 数据库设计文档 | 数据库架构、表结构和关系设计 | [查看文档](./docs/数据库设计文档.md) |
|
||||
| 错误处理和日志系统文档 | 错误处理机制和日志记录 | [查看文档](./docs/错误处理和日志系统文档.md) |
|
||||
| 系统集成和部署文档 | 系统部署和运维指南 | [查看文档](./docs/系统集成和部署文档.md) |
|
||||
| 前端开发文档 | 前端技术架构、组件设计和开发规范 | [查看文档](./docs/前端开发文档.md) |
|
||||
|
||||
#### 项目管理文档
|
||||
- **[项目开发进度报告](docs/项目开发进度报告.md)** - 项目进度跟踪和里程碑规划
|
||||
- **[开发规范和最佳实践](docs/开发规范和最佳实践.md)** - 团队开发规范和代码标准
|
||||
- **[测试文档](docs/测试文档.md)** - 测试策略、用例设计和质量保证
|
||||
|
||||
### 补充文档
|
||||
- 📄 [变更日志](CHANGELOG.md) - 项目版本变更记录
|
||||
- 📄 [贡献指南](docs/贡献指南.md) - 如何参与项目开发
|
||||
|
||||
Reference in New Issue
Block a user