docs: 更新 README.md 添加完整项目文档

jk-rag-platform/README.md

@@ -1,8 +1,10 @@
 # 建科小智开放平台
 
-**项目名称**: jk-rag-platform  
-**版本**: v3.0  
-**技术栈**: React 18 + TypeScript + Zustand + Vite + Ant Design
+**项目名称**: jk-rag-platform
+**版本**: v3.8
+**技术栈**: React 18 + TypeScript + Zustand + Vite + Ant Design + SCSS
+
+基于 RAG 技术的知识库管理与应用开发平台
 
 ## 🚀 快速开始
 
@@ -10,36 +12,130 @@
 # 安装依赖
 npm install
 
-# 启动开发服务器（Demo 模式）
+# 启动开发服务器（Demo 模式，静态 + Mock）
 npm run start:demo
 
-# 启动开发服务器（开发模式）
+# 启动开发服务器（开发模式，带 API）
 npm run start
 
 # 构建生产版本
 npm run build:prod
+
+# 构建 Demo 版本
+npm run build:demo
 ```
 
 ## 📁 项目结构
 
 ```
 src/
-├── components/common/     # 公共组件
+├── apis/                  # API 接口配置
+│   ├── api.ts             # Axios 实例和 Mock 配置
+│   ├── index.ts           # API 函数导出
+│   └── config.ts          # API 配置
+├── components/            # 公共组件
+│   ├── 404/               # 404 页面
+│   ├── chat/              # 聊天组件
+│   └── common/            # 通用组件
+│       ├── FilterBar/     # 筛选栏
+│       ├── FilterDrawer/  # 筛选抽屉
+│       ├── AppCard/       # 应用卡片
+│       ├── GuideTips/     # 引导提示
+│       ├── HeroBanner/    # 横幅
+│       ├── PageLayout/    # 页面布局
+│       └── StatsGrid/     # 统计卡片
+├── config/                # 配置文件
+├── mock/                  # Mock 数据
+│   ├── index.ts           # 全局 Mock 配置
+│   ├── knowledgeApi.ts    # 知识库 Mock API
+│   ├── applicationApi.ts  # 应用管理 Mock API
+│   ├── authApi.ts         # 认证 Mock API
+│   ├── auditApi.ts        # 审核管理 Mock API
+│   └── overviewApi.ts     # 首页统计 Mock API
 ├── pages/                 # 页面组件
+│   ├── appCenter/         # 应用中心
+│   ├── home/              # 首页/概览
+│   ├── knowledgeLib/      # 知识库管理
+│   ├── layout/            # 布局组件
+│   ├── login/             # 登录
+│   ├── questionAnswer/    # 问答应用
+│   ├── system/            # 系统管理
+│   │   ├── apiKey/        # API Key 管理
+│   │   └── audit/         # 应用审核
+│   └── universalChat/     # 智能问答
+├── store/                 # 状态管理 (Zustand)
+│   └── route.tsx          # 路由配置
 ├── styles/                # 全局样式
-├── store/                 # 状态管理
-└── utils/                 # 工具函数
+│   ├── variables.scss     # SCSS 变量
+│   └── global.scss        # 全局样式
+├── typings/               # 类型定义
+├── utils/                 # 工具函数
+│   ├── crypto.ts          # 加密工具
+│   └── jsencrypt.ts       # JS 加密
+├── LocalStorage.ts        # 本地存储封装
+├── App.tsx
+├── main.tsx
+└── router.tsx             # 路由配置
 ```
 
 ## 📋 主要功能
 
-- ✅ 应用广场
-- ✅ 知识库管理
-- ✅ 创建应用
-- ✅ API 管理
-- ✅ 应用审核
+### 应用中心
+- ✅ 应用广场 - 浏览所有 RAG 应用
+- ✅ 应用分类 - 专业知识、职能管理、项目级应用
+- ✅ 我创建的应用 - 管理个人创建的应用
+- ✅ 应用创建/编辑/删除
+
+### 知识库管理
+- ✅ 知识库列表 - CRUD 操作
+- ✅ 文档管理 - 上传、编辑、删除文档
+- ✅ 切片管理 - 查看、编辑、删除切片
+- ✅ 修订工具 - 切片修订和历史记录
+
+### 系统管理
+- ✅ API Key 管理
+- ✅ 应用审核 - 审核应用上线申请
+
+### 其他功能
+- ✅ 智能问答
+- ✅ 聊天记录管理
+- ✅ SSO 登录认证
+
+## 🔧 Mock 数据配置
+
+在 `src/apis/api.ts` 中修改 `USE_MOCK` 标志：
+
+```typescript
+const USE_MOCK = true;  // 启用 Mock 模式
+```
 
-## 📄 文档
+已实现的 Mock API：
+- 知识库管理（知识列表、文档管理、切片管理）
+- 修订工具（修订列表、修订历史）
+- 应用管理（应用列表、详情、CRUD）
+- 认证登录（登录、验证码、用户信息）
+- 审核管理（审核列表、审核操作、统计）
+- 首页统计（概览数据、在线用户、会话数据）
 
+## 🎨 样式规范
+
+使用全局 SCSS 变量，文件顶部必须导入：
+
+```scss
+@import '@/styles/variables.scss';
+```
+
+主要变量：
+- `$primary-color`: #005D80 - 企业主色
+- `$spacing-*`: 4px 基准间距系统
+- `$radius-*`: 圆角系统
+
+## 📄 相关文档
+
+- [.claude-rules.md](./.claude-rules.md) - 项目开发规范
 - [项目修改记录](./项目修改记录.md)
 - [设计规范](./建科小智设计规范_v3.md)
+
+---
+
+**最后更新**: 2026-04-02