96 lines
2.2 KiB
Markdown
96 lines
2.2 KiB
Markdown
# Yana iOS 项目
|
||
|
||
## 项目简介
|
||
|
||
Yana 是一个基于 iOS 平台的即时通讯应用，使用 Swift 语言开发，集成了网易云信 SDK 实现即时通讯功能。
|
||
|
||
## 技术栈
|
||
|
||
- 开发语言：Swift
|
||
- 最低支持版本：iOS 15.6
|
||
- 主要框架：
|
||
- NIMSDK_LITE：网易云信即时通讯 SDK
|
||
- NEChatKit：聊天核心组件
|
||
- NEChatUIKit：会话（聊天）UI 组件
|
||
- NEContactUIKit：通讯录 UI 组件
|
||
- NELocalConversationUIKit：本地会话列表 UI 组件
|
||
- Alamofire：网络请求框架
|
||
|
||
## 项目结构
|
||
|
||
```
|
||
yana/
|
||
├── AppDelegate.swift # 应用程序代理
|
||
├── yanaApp.swift # SwiftUI 应用入口
|
||
├── ContentView.swift # 主视图
|
||
├── Managers/ # 管理器类
|
||
├── Models/ # 数据模型
|
||
├── Configs/ # 配置文件
|
||
└── Assets.xcassets/ # 资源文件
|
||
```
|
||
|
||
## 环境要求
|
||
|
||
- Xcode 13.0 或更高版本
|
||
- iOS 15.6 或更高版本
|
||
- CocoaPods 包管理器
|
||
|
||
## 安装步骤
|
||
|
||
1. 克隆项目到本地
|
||
2. 在项目根目录执行：
|
||
|
||
```bash
|
||
pod install
|
||
```
|
||
|
||
3. 打开 `yana.xcworkspace` 文件
|
||
4. 编译运行项目
|
||
|
||
## 主要功能
|
||
|
||
- 即时通讯
|
||
- 会话管理
|
||
- 通讯录管理
|
||
- 本地会话列表
|
||
|
||
## API 使用
|
||
|
||
项目提供了完整的 API 架构，基于 TCA (The Composable Architecture) 设计：
|
||
|
||
- 📖 **[API 使用指南](API-README.md)** - 完整的 API 使用文档
|
||
- 🔧 **[API 规则详解](yana/APIs/API%20rule.md)** - API 请求配置和安全机制
|
||
- 🚀 **[集成指南](yana/APIs/Integration-Guide.md)** - API 集成和最佳实践
|
||
|
||
### 快速开始
|
||
|
||
```swift
|
||
// 基本 API 请求示例
|
||
let apiService = LiveAPIService()
|
||
let request = ConfigRequest()
|
||
let response = try await apiService.request(request)
|
||
```
|
||
|
||
## 注意事项
|
||
|
||
- 项目使用 CocoaPods 管理依赖
|
||
- 需要配置网易云信相关密钥
|
||
- 最低支持 iOS 15.6 版本
|
||
|
||
## 开发规范
|
||
|
||
- 遵循 Swift 官方编码规范
|
||
- 使用 SwiftUI 构建用户界面
|
||
- 采用 MVVM 架构模式
|
||
|
||
## 依赖版本
|
||
|
||
- NIMSDK 相关组件版本：10.6.1
|
||
- Alamofire：最新版本
|
||
|
||
## 构建配置
|
||
|
||
- 项目使用动态框架
|
||
- 支持 iOS 13.0 及以上版本
|
||
- 已配置框架冲突处理脚本
|