由于本次代码变更内容为空,无法生成有效的提交信息
This commit is contained in:
56
docs/开发指南.md
56
docs/开发指南.md
@@ -2,7 +2,21 @@
|
||||
|
||||
## 📋 项目概述
|
||||
|
||||
结伴客是一个基于微信小程序的结伴旅行和动物认领平台。本开发指南旨在帮助开发者快速上手项目开发,理解项目架构,并遵循统一的开发规范。
|
||||
结伴客是一个创新的社交旅行平台,融合了结伴旅行和动物认领功能。本开发指南为开发者提供完整的开发环境搭建、代码规范、最佳实践等指导,帮助团队高效协作开发。
|
||||
|
||||
## 🎯 开发目标
|
||||
|
||||
### 代码质量目标
|
||||
- **可维护性**:代码结构清晰,易于理解和修改
|
||||
- **可扩展性**:支持功能快速迭代和模块化扩展
|
||||
- **性能优化**:响应时间 < 200ms,并发支持 1000+
|
||||
- **安全性**:数据安全,防止常见安全漏洞
|
||||
|
||||
### 团队协作目标
|
||||
- **统一规范**:代码风格、命名规范、提交规范统一
|
||||
- **文档完善**:API文档、技术文档实时更新
|
||||
- **测试覆盖**:单元测试覆盖率 > 80%
|
||||
- **持续集成**:自动化构建、测试、部署
|
||||
|
||||
## 🛠️ 开发环境搭建
|
||||
|
||||
@@ -10,42 +24,54 @@
|
||||
|
||||
#### 前端开发环境
|
||||
- **Node.js**: 16.0+ (推荐使用 18.x LTS)
|
||||
- **npm**: 8.0+ 或 **yarn**: 1.22+
|
||||
- **微信开发者工具**: 最新稳定版
|
||||
- **包管理器**: npm 8.0+ 或 yarn 1.22+ 或 pnpm 7.0+
|
||||
- **微信开发者工具**: 最新稳定版 (1.06.x)
|
||||
- **IDE**: VS Code (推荐) / WebStorm
|
||||
- **Git**: 2.30+
|
||||
- **浏览器**: Chrome 100+ (开发调试)
|
||||
|
||||
#### 后端开发环境
|
||||
- **JDK**: Java 17 (推荐使用 OpenJDK)
|
||||
- **Maven**: 3.6+
|
||||
- **Node.js**: 16.0+ (主要后端)
|
||||
- **JDK**: Java 17 (微服务版本,推荐使用 OpenJDK)
|
||||
- **Maven**: 3.6+ (Java项目构建)
|
||||
- **IDE**: IntelliJ IDEA (推荐) / Eclipse / VS Code
|
||||
- **数据库**: MySQL 8.0+
|
||||
- **缓存**: Redis 6.0+
|
||||
- **消息队列**: RabbitMQ 3.8+
|
||||
- **消息队列**: RabbitMQ 3.8+ (可选)
|
||||
- **容器化**: Docker 20.10+ 和 Docker Compose 1.29+
|
||||
|
||||
### 环境安装
|
||||
### 快速环境安装
|
||||
|
||||
#### macOS 环境安装
|
||||
```bash
|
||||
# 使用 Homebrew 安装开发工具
|
||||
# 安装 Node.js
|
||||
# 1. 安装 Homebrew (如果未安装)
|
||||
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
|
||||
|
||||
# 2. 安装 Node.js 和 npm
|
||||
brew install node
|
||||
|
||||
# 安装 Java 17
|
||||
# 3. 安装 Java 17
|
||||
brew install openjdk@17
|
||||
echo 'export PATH="/opt/homebrew/opt/openjdk@17/bin:$PATH"' >> ~/.zshrc
|
||||
|
||||
# 安装 Maven
|
||||
# 4. 安装 Maven
|
||||
brew install maven
|
||||
|
||||
# 安装 Docker
|
||||
# 5. 安装 Docker
|
||||
brew install docker docker-compose
|
||||
|
||||
# 安装 MySQL
|
||||
brew install mysql
|
||||
# 6. 安装数据库
|
||||
brew install mysql redis
|
||||
|
||||
# 安装 Redis
|
||||
brew install redis
|
||||
# 7. 安装开发工具
|
||||
brew install git wget curl
|
||||
|
||||
# 8. 验证安装
|
||||
node --version # 应显示 v16.x 或更高
|
||||
java --version # 应显示 Java 17
|
||||
mvn --version # 应显示 Maven 3.6+
|
||||
docker --version # 应显示 Docker 20.10+
|
||||
```
|
||||
|
||||
#### Windows 环境安装
|
||||
|
||||
Reference in New Issue
Block a user