68 lines
1.5 KiB
Markdown
68 lines
1.5 KiB
Markdown
# 云酒馆项目文档
|
||
|
||
## 目录
|
||
|
||
- [项目概述](./overview.md)
|
||
- [架构设计](./architecture.md)
|
||
- [API 文档](./api.md)
|
||
- [前端开发指南](./frontend-guide.md)
|
||
- [后端开发指南](./backend-guide.md)
|
||
- [部署指南](./deployment.md)
|
||
- [设计系统](./design-system/)
|
||
|
||
## 项目架构
|
||
|
||
```
|
||
云酒馆平台
|
||
├── 前端 (web-app)
|
||
│ ├── 公共页面（首页、角色广场、角色详情）
|
||
│ ├── 用户系统（登录、注册、用户中心）
|
||
│ ├── 管理功能（角色卡管理、预设管理）
|
||
│ └── 对话功能（聊天界面、历史记录）
|
||
│
|
||
└── 后端 (server)
|
||
├── 用户认证 (JWT)
|
||
├── 角色卡 API
|
||
├── 对话管理 API
|
||
├── 预设管理 API
|
||
└── AI 集成
|
||
```
|
||
|
||
## 核心功能
|
||
|
||
### 角色卡系统
|
||
- 支持 PNG 格式角色卡（嵌入 JSON 数据）
|
||
- 支持纯 JSON 格式角色卡
|
||
- 角色信息编辑
|
||
- 导入导出功能
|
||
|
||
### 预设系统
|
||
- 支持多种预设格式（SillyTavern、TavernAI 等）
|
||
- 参数配置（Temperature、Top P、Top K 等）
|
||
- 预设复制和导出
|
||
|
||
### 对话系统
|
||
- 实时消息发送
|
||
- 对话历史管理
|
||
- 多角色对话支持
|
||
- 对话导出功能
|
||
|
||
## 开发规范
|
||
|
||
### 代码风格
|
||
- 前端：ESLint + Prettier
|
||
- 后端：ESLint
|
||
- 提交信息：Conventional Commits
|
||
|
||
### Git 工作流
|
||
- main: 生产环境
|
||
- develop: 开发环境
|
||
- feature/*: 功能分支
|
||
- bugfix/*: 修复分支
|
||
|
||
## 快速链接
|
||
|
||
- [前端 README](../web-app/README.md)
|
||
- [后端 README](../server/README.md)
|
||
- [设计系统](./design-system/)
|