Files
012-kaopeilian/docs/SETUP.md
111 998211c483 feat: 初始化考培练系统项目
- 从服务器拉取完整代码
- 按框架规范整理项目结构
- 配置 Drone CI 测试环境部署
- 包含后端(FastAPI)、前端(Vue3)、管理端

技术栈: Vue3 + TypeScript + FastAPI + MySQL
2026-01-24 19:33:28 +08:00

117 lines
2.6 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 快速设置指南
## 1. 配置Coze API认证
### 步骤1: 创建本地配置文件
复制示例配置文件:
```bash
cd coze-chat-backend
cp local_config.py.example local_config.py
```
### 步骤2: 配置API Token
编辑 `local_config.py` 文件配置您的PAT Token
```python
# Coze API 配置
COZE_API_BASE = "https://api.coze.cn"
COZE_WORKSPACE_ID = "7474971491470688296"
COZE_API_TOKEN = "your_pat_token_here" # 替换为您的PAT Token
```
## 2. 启动系统
### 方式1: 使用启动脚本 (推荐)
```bash
./start.sh
```
### 方式2: 手动启动
**启动后端:**
```bash
cd coze-chat-backend
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
python main.py
```
> 网络与代理(重要):若公司网络有 HTTP/HTTPS 代理,可能导致访问 `https://api.coze.cn` 失败(如 `500 Internal Privoxy Error`)。建议在启动前执行:
```bash
unset http_proxy https_proxy all_proxy HTTP_PROXY HTTPS_PROXY ALL_PROXY
export NO_PROXY=localhost,127.0.0.1,api.coze.cn,.coze.cn
```
`./start.sh` 已默认设置上述环境,手动启动时请自行执行。
**启动前端:**
```bash
cd coze-chat-frontend
npm install
npm run dev
```
## 3. 访问系统
- **前端页面**: http://localhost:3006
- **后端API**: http://localhost:8000
- **API文档**: http://localhost:8000/docs
## 4. 功能说明
### 首页 - 智能体列表
- 自动加载工作空间 `7474971491470688296` 内的所有智能体
- 点击任意智能体卡片进入聊天界面
- 显示智能体名称、描述和头像
### 聊天页面 - 对话界面
- 实时流式聊天对话
- 消息气泡展示
- 支持对话中断
- 显示智能体建议问题
## 5. 故障排除
### 问题1: 后端启动失败
```
检查 local_config.py 文件配置是否正确
确认PAT Token有效
查看终端错误信息
```
### 问题2: 前端API调用失败
```
确认后端服务已启动 (http://localhost:8000)
检查浏览器控制台错误信息
确认 utils/api.ts 中的API地址配置
```
### 问题3: 智能体列表为空
```
确认工作空间ID正确
检查Coze API认证是否成功
查看后端日志中的详细错误信息
```
## 6. 开发说明
### 添加新功能
1. 后端API: 在 `coze-chat-backend/main.py` 中添加新接口
2. 前端调用: 在 `coze-chat-frontend/src/server/api.ts` 中添加API方法
3. 状态管理: 在相应的Store中添加业务逻辑
### 自定义样式
- 主页样式: `coze-chat-frontend/src/pages/Home/index.scss`
- 聊天界面: `coze-chat-frontend/src/components/MessageList/index.scss`
### Docker部署
```bash
cd coze-chat-backend
docker-compose up -d
```
前端需要单独部署或者构建静态文件后配置nginx。