docs: Add comprehensive README with cloning instructions
- Project overview and tech stack - Detailed cloning instructions with resource file requirements - Explanation of why resources are not in Git (224MB excluded) - Common issues and troubleshooting guide - Contribution guidelines
This commit is contained in:
edwinQQQ
199
README.md
Normal file
199
README.md
Normal file
@@ -0,0 +1,199 @@
|
||||
# E-Parti iOS (YuMi/MoliStar)
|
||||
|
||||
iOS 社交娱乐平台 - 支持直播、即时通讯、音视频通话、互动游戏等功能。
|
||||
|
||||
## 环境要求
|
||||
|
||||
- **iOS**: 13.0+
|
||||
- **Xcode**: 14.0+
|
||||
- **CocoaPods**: 1.11.0+
|
||||
|
||||
## 技术栈
|
||||
|
||||
| 类别 | 技术 |
|
||||
|-----|-----|
|
||||
| **语言** | Objective-C |
|
||||
| **架构** | MVC + MVP |
|
||||
| **依赖管理** | CocoaPods |
|
||||
| **即时通讯** | 网易云信 IM |
|
||||
| **音视频** | 腾讯 TRTC |
|
||||
| **UI框架** | Masonry, JXCategoryView |
|
||||
| **图片加载** | SDWebImage, YYWebImage |
|
||||
| **动画** | libpag, SVGAPlayer, QGVAPlayer |
|
||||
|
||||
## 多语言支持
|
||||
|
||||
🌍 支持 8 种语言：英语、中文、土耳其语、阿拉伯语、葡萄牙语、西班牙语、俄语、乌兹别克语
|
||||
|
||||
## 快速开始
|
||||
|
||||
### 1. 克隆仓库
|
||||
|
||||
```bash
|
||||
git clone https://git.moliparty.com/xindegitzhanghao/real-e-party-iOS.git
|
||||
cd real-e-party-iOS
|
||||
git checkout Company/Dev
|
||||
```
|
||||
|
||||
### 2. ⚠️ 获取资源文件（重要）
|
||||
|
||||
**由于资源文件未提交到 Git（优化仓库大小），需要单独获取以下目录：**
|
||||
|
||||
```
|
||||
📦 YuMi/Assets.xcassets/ (63 MB) - 图片资源
|
||||
📦 YuMi/Library/ (138 MB) - 第三方 SDK Framework
|
||||
📦 YuMi/Resources/ (23 MB) - 动画视频资源
|
||||
```
|
||||
|
||||
**获取方式：**
|
||||
- 方式 1: 联系项目管理员获取资源压缩包
|
||||
- 方式 2: 从云存储下载（待配置）
|
||||
- 方式 3: 从其他开发者的本地拷贝
|
||||
|
||||
**资源目录放置位置：**
|
||||
```
|
||||
real-e-party-iOS/
|
||||
├── YuMi/
|
||||
│ ├── Assets.xcassets/ ← 放这里
|
||||
│ ├── Library/ ← 放这里
|
||||
│ └── Resources/ ← 放这里
|
||||
```
|
||||
|
||||
### 3. 安装依赖
|
||||
|
||||
```bash
|
||||
pod install
|
||||
```
|
||||
|
||||
### 4. 打开项目
|
||||
|
||||
```bash
|
||||
# ⚠️ 必须使用 .xcworkspace 打开
|
||||
open YuMi.xcworkspace
|
||||
```
|
||||
|
||||
## 项目结构
|
||||
|
||||
```
|
||||
E-Parti/
|
||||
├── YuMi/ # 主工程
|
||||
│ ├── Appdelegate/ # 应用生命周期
|
||||
│ ├── Assets.xcassets/ # 图片资源 (不在 Git 中)
|
||||
│ ├── Config/ # 配置文件
|
||||
│ ├── CustomUI/ # 自定义UI组件
|
||||
│ ├── Library/ # 第三方SDK (不在 Git 中)
|
||||
│ ├── Modules/ # 业务模块
|
||||
│ │ ├── YMRoom/ # 房间模块
|
||||
│ │ ├── YMMine/ # 我的模块
|
||||
│ │ ├── YMMessage/ # 消息模块
|
||||
│ │ ├── YMLogin/ # 登录模块
|
||||
│ │ └── ...
|
||||
│ ├── Resources/ # 动画资源 (不在 Git 中)
|
||||
│ ├── Structure/ # 基础架构
|
||||
│ ├── Tools/ # 工具类
|
||||
│ └── *.lproj/ # 多语言资源
|
||||
├── Pods/ # CocoaPods 依赖 (不在 Git 中)
|
||||
├── YuMi.xcodeproj/ # Xcode 项目
|
||||
├── YuMi.xcworkspace/ # Xcode 工作空间
|
||||
├── Podfile # 依赖配置
|
||||
└── .gitignore # Git 忽略规则
|
||||
```
|
||||
|
||||
## 为什么资源文件不在 Git 中？
|
||||
|
||||
为了优化仓库大小，以下文件使用独立分发：
|
||||
|
||||
| 目录 | 大小 | 原因 |
|
||||
|-----|------|------|
|
||||
| `Assets.xcassets` | 63 MB | 大量图片资源，更新频率低 |
|
||||
| `Library` | 138 MB | 第三方 SDK Framework，二进制文件 |
|
||||
| `Resources` | 23 MB | SVGA/MP4 动画，大文件 |
|
||||
| **总计** | **224 MB** | Git 仓库从 151MB 优化到 33MB |
|
||||
|
||||
**优点：**
|
||||
- ⚡️ 克隆速度快（33 MB vs 151 MB）
|
||||
- 🚀 推送/拉取更快
|
||||
- 💾 节省服务器存储
|
||||
- 🔄 代码变更不受资源文件影响
|
||||
|
||||
## 开发注意事项
|
||||
|
||||
### 1. CocoaPods
|
||||
|
||||
```bash
|
||||
# 首次安装或依赖更新后
|
||||
pod install
|
||||
|
||||
# 清理缓存（如遇问题）
|
||||
pod cache clean --all
|
||||
rm -rf Pods/ Podfile.lock
|
||||
pod install
|
||||
```
|
||||
|
||||
### 2. 不要提交的文件
|
||||
|
||||
已配置 `.gitignore`，以下文件会自动忽略：
|
||||
- `Pods/` - CocoaPods 依赖
|
||||
- `YuMi/Assets.xcassets/` - 图片资源
|
||||
- `YuMi/Library/` - 第三方 SDK
|
||||
- `YuMi/Resources/` - 动画资源
|
||||
- `*.xcuserstate` - Xcode 用户状态
|
||||
- `*.xcworkspace/xcuserdata/` - 用户数据
|
||||
|
||||
### 3. 第三方服务配置
|
||||
|
||||
项目使用了多个第三方服务，需要配置：
|
||||
|
||||
- **Facebook SDK** - `YuMi/Info.plist`
|
||||
- **Google Sign-In** - `YuMi/GoogleService-Info.plist`
|
||||
- **腾讯云 TRTC** - SDK 配置
|
||||
- **网易云信** - IM 配置
|
||||
- **Mob SDK** - 分享配置
|
||||
|
||||
## 常见问题
|
||||
|
||||
### Q: 克隆后编译报错找不到图片资源？
|
||||
**A:** 需要获取 `YuMi/Assets.xcassets/` 目录，参考上面"获取资源文件"步骤。
|
||||
|
||||
### Q: 编译报错找不到 Framework？
|
||||
**A:** 需要获取 `YuMi/Library/` 目录，或者运行 `pod install`。
|
||||
|
||||
### Q: CocoaPods 安装失败？
|
||||
**A:**
|
||||
```bash
|
||||
pod cache clean --all
|
||||
rm -rf Pods/ Podfile.lock
|
||||
pod install
|
||||
```
|
||||
|
||||
### Q: Xcode 编译错误？
|
||||
**A:**
|
||||
```bash
|
||||
# 清理构建缓存
|
||||
rm -rf ~/Library/Developer/Xcode/DerivedData/
|
||||
# 在 Xcode 中: Product -> Clean Build Folder (⇧⌘K)
|
||||
```
|
||||
|
||||
## 贡献指南
|
||||
|
||||
1. 从 `Company/Dev` 分支创建功能分支
|
||||
2. 开发完成后提交代码（资源文件会自动忽略）
|
||||
3. 推送并创建 Merge Request
|
||||
|
||||
```bash
|
||||
git checkout -b feature/your-feature
|
||||
# ... 开发 ...
|
||||
git add .
|
||||
git commit -m "feat: Add your feature"
|
||||
git push Company feature/your-feature
|
||||
```
|
||||
|
||||
## 联系方式
|
||||
|
||||
- **Git 仓库**: https://git.moliparty.com/xindegitzhanghao/real-e-party-iOS
|
||||
- **GitHub 镜像**: https://github.com/EggmanQi/e-parti
|
||||
|
||||
---
|
||||
|
||||
**💡 提示**: 本项目已优化 Git 仓库大小（从 151MB → 33MB），大型资源文件需单独获取。
|
||||
|
||||
Reference in New Issue
Block a user