Ryuiso 302e0e2862 docs: 重写 API 文档,参考 Dify 风格只保留 RAG 调用和知识库检索接口 1 month ago
..
.claude cd8dbdcda7 style: 修复 SCSS 文件中的硬编码颜色和间距值 1 month ago
docs 302e0e2862 docs: 重写 API 文档,参考 Dify 风格只保留 RAG 调用和知识库检索接口 1 month ago
env d6c8acff15 no message 1 month ago
src 9302c02dc2 style: 统一 Ant Design 组件圆角为 8px,符合设计规范 1 month ago
.claude-rules.md fe4912b557 docs: 更新 .claude-rules.md 标记文档任务已完成 1 month ago
.gitignore b72a2f93d8 忽略文件 1 month ago
README.md 2fcfaaaa92 docs: 更新 README.md 添加完整项目文档 1 month ago
demo.log d6c8acff15 no message 1 month ago
index.html c77472d7f2 less -> SCSS 1 month ago
package.json cd8dbdcda7 style: 修复 SCSS 文件中的硬编码颜色和间距值 1 month ago
test-migration.js d6c8acff15 no message 1 month ago
tsconfig.json d6c8acff15 no message 1 month ago
vite.config.ts 1becaf89fc LESS → SCSS 迁移完成 1 month ago
知识库路由和 Mock 数据说明.md d6c8acff15 no message 1 month ago
页面布局与间距控制规范.md d6c8acff15 no message 1 month ago

README.md

建科小智开放平台

项目名称: jk-rag-platform 版本: v3.8 技术栈: React 18 + TypeScript + Zustand + Vite + Ant Design + SCSS

基于 RAG 技术的知识库管理与应用开发平台

🚀 快速开始

# 安装依赖
npm install

# 启动开发服务器(Demo 模式,静态 + Mock)
npm run start:demo

# 启动开发服务器(开发模式,带 API)
npm run start

# 构建生产版本
npm run build:prod

# 构建 Demo 版本
npm run build:demo

📁 项目结构

src/
├── 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/                # 全局样式
│   ├── variables.scss     # SCSS 变量
│   └── global.scss        # 全局样式
├── typings/               # 类型定义
├── utils/                 # 工具函数
│   ├── crypto.ts          # 加密工具
│   └── jsencrypt.ts       # JS 加密
├── LocalStorage.ts        # 本地存储封装
├── App.tsx
├── main.tsx
└── router.tsx             # 路由配置

📋 主要功能

应用中心

  • ✅ 应用广场 - 浏览所有 RAG 应用
  • ✅ 应用分类 - 专业知识、职能管理、项目级应用
  • ✅ 我创建的应用 - 管理个人创建的应用
  • ✅ 应用创建/编辑/删除

知识库管理

  • ✅ 知识库列表 - CRUD 操作
  • ✅ 文档管理 - 上传、编辑、删除文档
  • ✅ 切片管理 - 查看、编辑、删除切片
  • ✅ 修订工具 - 切片修订和历史记录

系统管理

  • ✅ API Key 管理
  • ✅ 应用审核 - 审核应用上线申请

其他功能

  • ✅ 智能问答
  • ✅ 聊天记录管理
  • ✅ SSO 登录认证

🔧 Mock 数据配置

src/apis/api.ts 中修改 USE_MOCK 标志:

const USE_MOCK = true;  // 启用 Mock 模式

已实现的 Mock API:

  • 知识库管理(知识列表、文档管理、切片管理)
  • 修订工具(修订列表、修订历史)
  • 应用管理(应用列表、详情、CRUD)
  • 认证登录(登录、验证码、用户信息)
  • 审核管理(审核列表、审核操作、统计)
  • 首页统计(概览数据、在线用户、会话数据)

🎨 样式规范

使用全局 SCSS 变量,文件顶部必须导入:

@import '@/styles/variables.scss';

主要变量:

  • $primary-color: #005D80 - 企业主色
  • $spacing-*: 4px 基准间距系统
  • $radius-*: 圆角系统

📄 相关文档


最后更新: 2026-04-02