开发指南
面向开发者的系统架构说明、部署指南和二次开发文档
系统架构
AI云营采用前后端分离架构,主要包含以下组件:
🎨 前端 (Frontend)
技术栈:HTML5 / CSS3 / JavaScript
框架:原生JS + 响应式设计
构建:Vite / Webpack
⚙️ 后端 (Backend)
技术栈:Python 3.10+
框架:FastAPI
数据库:SQLite / PostgreSQL
🤖 AI引擎 (AI Engine)
智能体框架:自研
LLM支持:OpenAI / 本地模型
工作流:自研引擎
环境要求
| 组件 | 最低要求 | 推荐配置 |
|---|---|---|
| 操作系统 | Windows 10 / macOS 10.15 / Ubuntu 18.04 | Windows 11 / macOS 13 / Ubuntu 22.04 |
| Python | 3.10+ | 3.11+ |
| 内存 | 8GB | 16GB+ |
| 硬盘 | 20GB可用空间 | 50GB+ SSD |
| Node.js | 16+ | 18+ (仅前端开发) |
快速部署
1. 克隆代码
git clone https://github.com/aiyunying/aiyunying.git
cd aiyunying
2. 安装依赖
# 后端依赖
cd backend
pip install -r requirements.txt
# 前端依赖 (开发模式)
cd ../index
npm install
3. 配置环境
# 复制环境变量模板
cp .env.example .env
# 编辑配置文件
# 填入必要的配置项
4. 启动服务
# 启动后端
cd backend
python main.py
# 启动前端 (开发模式)
cd ../index
npm run dev
5. 访问系统
打开浏览器访问 http://localhost:3000 即可使用。
项目结构
aiyunying/
├── backend/ # 后端代码
│ ├── app/ # 应用核心
│ │ ├── core/ # 核心模块
│ │ ├── modules/ # 业务模块
│ │ └── services/ # 服务层
│ ├── data/ # 数据目录
│ ├── main.py # 入口文件
│ └── requirements.txt # Python依赖
├── index/ # 官网/落地页
│ ├── css/ # 样式文件
│ ├── js/ # 脚本文件
│ └── pages/ # 内页
├── frontend/ # 管理后台前端
├── docker/ # Docker配置
└── scripts/ # 脚本工具
二次开发
添加自定义模块
在 backend/app/modules/ 目录下创建新的模块目录:
backend/app/modules/
└── your_module/
├── __init__.py
├── router.py # API路由
├── service.py # 业务逻辑
└── models.py # 数据模型
注册模块
在 main.py 中注册新模块的路由:
from app.modules.your_module.router import router as your_module_router
app.include_router(your_module_router, prefix="/api/your-module")
添加智能体
在 agents_config.py 中定义新的智能体角色:
NEW_AGENT = {
"name": "your_agent",
"role": "角色名称",
"description": "角色描述",
"capabilities": ["能力1", "能力2"],
"tools": ["tool1", "tool2"]
}
插件开发
AI云营支持插件扩展,您可以开发自定义插件来增强系统功能。
插件结构
your_plugin/
├── __init__.py
├── manifest.json # 插件清单
├── main.py # 插件入口
└── static/ # 静态资源
manifest.json
{
"name": "your_plugin",
"version": "1.0.0",
"description": "插件描述",
"author": "Your Name",
"main": "main.py",
"permissions": ["read", "write"]
}