docs: 交付文档、维护指引与端到端回归
补齐 README、开发计划、维护交接与 E2E 用例,执行最终验收。
This commit is contained in:
1 parent
18732801b5
commit
6cd904d460
216 files changed
+37038
No files matched your search
@@ -0,0 +1,60 @@
|
||||
# ReplyPier
|
||||
|
||||
ReplyPier 是面向个人与公司网站的 AI 客服系统,支持知识库问答、AI 转人工、多客服协作与服务评价。
|
||||
|
||||
## 使用与开发文档
|
||||
|
||||
- [本机使用与启停](LOCAL_DEPLOY.md)
|
||||
- [开发与维护指引](AGENT_HANDOFF.md)
|
||||
- [从零开发逐日计划:9 月 21 日—10 月 21 日](FROM_ZERO_PLAN.md)
|
||||
|
||||
## 核心能力
|
||||
|
||||
- 网站悬浮客服入口与嵌入式聊天窗口。
|
||||
- 基于指定知识库的 AI 问答与会话上下文。
|
||||
- 同一会话内转人工、客服接管与授权转交。
|
||||
- 管理员与人工客服角色、客服分组和会话访问控制。
|
||||
- 服务星级、文字评价、聊天记录与基础统计。
|
||||
- 可配置的 Agent、知识处理任务与工作流。
|
||||
|
||||
## 技术结构
|
||||
|
||||
- 后端:Python、FastAPI、SQLAlchemy、Alembic。
|
||||
- 前端:Vue 3、TypeScript、Vite。
|
||||
- 实时通信:Socket.IO。
|
||||
- 知识检索:FastEmbed、PostgreSQL/pgvector。
|
||||
- 短期状态与事件分发:Redis。
|
||||
- AI 编排:Agno。
|
||||
|
||||
```text
|
||||
backend/app/ API、业务模型、Agent、知识处理与后台任务
|
||||
backend/tests/ 后端测试
|
||||
frontend/src/ 管理后台、客服工作台与嵌入 Widget
|
||||
e2e/ 端到端测试
|
||||
deploy/local/ 本机环境与启停脚本
|
||||
```
|
||||
|
||||
## 本机使用
|
||||
|
||||
在项目根目录执行:
|
||||
|
||||
```bash
|
||||
./deploy/local/local.sh up
|
||||
./deploy/local/local.sh status
|
||||
```
|
||||
|
||||
- [客服工作台](http://127.0.0.1:3018/)
|
||||
- [悬浮客服演示页](http://127.0.0.1:3018/local-demo.html)
|
||||
|
||||
账号、构建、日志、数据恢复及公网接入条件见 [LOCAL_DEPLOY.md](LOCAL_DEPLOY.md)。
|
||||
|
||||
## 开发检查
|
||||
|
||||
- 后端测试位于 `backend/tests/`。
|
||||
- 前端类型检查:在 `frontend/` 执行 `npm run type-check`。
|
||||
- 前端单元测试:在 `frontend/` 执行 `npm run test:unit`。
|
||||
- 端到端测试约定见 [e2e/AUTHORING.md](e2e/AUTHORING.md)。
|
||||
|
||||
## 许可与贡献
|
||||
|
||||
许可条款见 [LICENSE](LICENSE),声明见 [NOTICE](NOTICE),贡献约定见 [CONTRIBUTING.md](CONTRIBUTING.md)。
|
||||
Reference in new issue
Block a user