VitePress

Appearance

开发指南 ​

欢迎查看RAGFlow的开发指南，这里包含了完整的开发文档和最佳实践。

Claude Code 使用指南 ​

Claude Code 使用指南 - 为Claude Code准备的项目指导文档，包括：

  • 项目概览和架构说明
  • 常用开发命令
  • 代码规范和最佳实践
  • 调试和测试方法
  • 部署和运维指南

节点开发指南 ​

节点开发指南 - 完整的节点开发步骤和最佳实践：

开发流程 ​

  1. 需求分析和设计
  2. 后端组件开发
  3. 前端节点开发
  4. 测试和验证
  5. 文档编写
  6. 部署发布

技术要点 ​

  • 后端：Python组件类开发
  • 前端：React节点组件开发
  • 参数配置：TypeScript接口定义
  • 表单设计：Ant Design组件使用
  • 状态管理：Zustand集成
  • API集成：RESTful接口设计

工作流执行指南 ​

工作流执行指南 - 工作流执行机制的详细解释：

执行流程 ​

  1. DSL JSON解析
  2. 组件依赖分析
  3. 执行计划生成
  4. 并行执行调度
  5. 结果收集和输出

核心机制 ​

  • 智能依赖解析
  • 并行执行优化
  • 错误恢复机制
  • 流式结果推送
  • 缓存和性能优化

开发环境搭建 ​

前端开发环境 ​

bash
cd web
npm install
npm run start

后端开发环境 ​

bash
pip install -r requirements.txt
python ragflow_server.py

数据库配置 ​

  • MySQL: 存储元数据
  • Redis: 缓存和会话管理
  • Elasticsearch: 向量检索

开发最佳实践 ​

  1. 代码规范 - 遵循项目的代码风格指南
  2. 测试驱动 - 为新功能编写完整的测试用例
  3. 文档优先 - 及时更新相关文档
  4. 性能考虑 - 注意组件的性能和资源消耗
  5. 安全意识 - 验证输入参数，避免安全漏洞

调试和测试 ​

前端调试 ​

  • 使用浏览器开发者工具
  • React DevTools
  • Redux DevTools (Zustand)

后端调试 ​

  • Python debugger (pdb)
  • 日志记录和分析
  • 性能分析工具

测试策略 ​

  • 单元测试：组件功能测试
  • 集成测试：组件间交互测试
  • 端到端测试：完整工作流测试