998211c483
- 从服务器拉取完整代码 - 按框架规范整理项目结构 - 配置 Drone CI 测试环境部署 - 包含后端(FastAPI)、前端(Vue3)、管理端 技术栈: Vue3 + TypeScript + FastAPI + MySQL
4.2 KiB
4.2 KiB
考培练系统后端开发拆分策略
本目录包含了考培练系统后端开发的完整拆分策略和实施指南，用于指导多个子Agent协同开发后端系统。
📁 文档结构
1. 项目脚手架结构
- 完整的项目目录结构
- AI平台（Coze & Dify）集成架构
- 配置文件示例
- 环境变量配置
2. 开发规范文档
- Python代码规范
- API开发规范
- 数据库规范
- 异常处理规范
- 日志规范
- 测试规范
- Git提交规范
- 代码审查清单
3. 模块分工指南
- 9个核心模块的详细划分
- 每个Agent的职责范围
- 模块间依赖关系
- API接口定义
- 开发时序安排
- 模块交付标准
4. 协作机制设计
- 全局上下文共享机制
- Agent间通信接口
- 代码集成策略
- 分布式事务管理
- 错误处理与恢复
- 监控与日志
- 开发工具与脚本
5. 质量保证机制
- 自动化代码检查
- 测试策略（单元/集成/性能）
- CI/CD配置
- 代码审查流程
- 安全保证
- 监控与告警
- 发布管理
6. 统一基础代码
- 主应用入口代码
- 系统配置管理
- 数据库配置
- 基础模型类
- 认证依赖注入
- 异常处理
- 日志配置
- 业务服务基类
- 常用工具函数
7. 快速开始指南
- 环境准备
- 项目初始化
- 数据库初始化
- 启动服务
- 开发工作流
- 模块开发指南
- 调试技巧
- 常见问题解决
🏗️ 系统架构概览
考培练系统后端
├── 认证授权模块 (Agent-Auth)
├── 用户管理模块 (Agent-User)
├── 课程管理模块 (Agent-Course)
├── 考试模块 (Agent-Exam)
├── AI陪练模块 (Agent-Training)
├── 数据分析模块 (Agent-Analytics)
├── 系统管理模块 (Agent-Admin)
├── Coze集成服务 (Agent-Coze)
└── Dify集成服务 (Agent-Dify)
🚀 快速开始
-
环境准备
# 克隆项目 git clone <repository-url> kaopeilian-backend cd kaopeilian-backend # 创建虚拟环境 python3 -m venv venv source venv/bin/activate # 安装依赖 pip install -r requirements/dev.txt -
配置环境
cp .env.example .env # 编辑.env文件配置数据库、AI平台等 -
初始化数据库
alembic upgrade head -
启动开发服务器
make run-dev
📋 开发流程
- 领取任务：根据模块分工指南领取对应模块
- 阅读规范：仔细阅读开发规范文档
- 创建分支：基于develop创建feature分支
- 编写代码：使用统一基础代码中的基类和工具
- 测试验证：按照质量保证机制进行测试
- 代码审查：提交PR等待审查
- 合并集成：通过审查后合并到develop分支
🤝 协作要点
- 统一规范：所有Agent必须遵循相同的代码规范
- 接口契约：严格按照定义的接口进行开发
- 及时沟通：通过消息总线和日志系统保持信息同步
- 质量第一：确保代码质量和测试覆盖率
- 文档完善：及时更新API文档和设计文档
📊 项目管理
- 进度跟踪：每日更新开发进度
- 问题反馈：使用Issue系统跟踪问题
- 代码审查：所有代码必须经过审查
- 持续集成：自动运行测试和代码检查
🛠️ 技术栈
- 后端框架：Python 3.8+ + FastAPI
- 数据库：MySQL 8.0 + Redis
- ORM：SQLAlchemy 2.0
- AI平台：Coze + Dify
- 测试框架：pytest
- 代码质量：Black + isort + flake8 + mypy
📞 联系方式
- 技术负责人：[联系方式]
- 项目管理：[联系方式]
- 问题反馈：[Issue链接]
📝 更新日志
- 2025-01-XX：初始版本发布
- 包含完整的项目架构设计
- 9个核心模块的详细分工
- 统一的开发规范和基础代码
注意：本文档会根据项目进展持续更新，请定期查看最新版本。