| # Human-Clone System | |
| Human-Clone 系统是一个多主体通讯协作平台,支持 human 和 clone 之间的实时异步通讯。 | |
| ## 快速开始 | |
| ### 环境要求 | |
| - Python 3.9+ | |
| - Redis 服务器 | |
| ### 安装依赖 | |
| ```bash | |
| pip install -r requirements.txt | |
| ``` | |
| ### 启动方式 | |
| #### 1. 直接启动(推荐) | |
| ```bash | |
| uvicorn src.main:app --reload --host 0.0.0.0 --port 7860 | |
| ``` | |
| #### 2. 使用脚本启动 | |
| ```bash | |
| python scripts/start_dev.py | |
| ``` | |
| #### 3. 开发模式 | |
| ```bash | |
| uvicorn src.main:app --reload --debug --port 7860 | |
| ``` | |
| ## API 文档 | |
| 启动后访问: | |
| - Swagger UI: http://localhost:7860/docs | |
| - ReDoc: http://localhost:7860/redoc | |
| ## 项目结构 | |
| ``` | |
| ├── src/ # 源代码目录 | |
| │ ├── core/ # 核心功能模块 | |
| │ ├── config/ # 配置管理 | |
| │ ├── api/ # API路由 | |
| │ └── utils/ # 工具函数 | |
| ├── tests/ # 测试代码 | |
| ├── scripts/ # 启动脚本 | |
| └── docs/ # 项目文档 | |
| ``` | |
| ## 核心功能 | |
| - 多主体(human/clone)实时通讯 | |
| - 基于 Redis 的异步消息传递 | |
| - 支持点对点消息发送 | |
| - 完全解耦的发送/接收队列机制 | |
| ## 开发指南 | |
| 详见 `docs/development-workflow.md` |