Refly项目开发环境搭建与贡献指南-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00596/article/details/148550237

Refly项目开发环境搭建与贡献指南

refly 🎨 Refly is an open-source AI-native creation engine. Its intuitive free-form canvas interface combines multi-threaded dialogues, artifacts, AI knowledge base integration, chrome extension clip & save, contextual memory, intelligent search, WYSIWYG AI editor and more, empowering you to effortlessly transform ideas into production-ready content. 项目地址: https://gitcode.com/gh_mirrors/re/refly

项目概述

Refly是一个AI原生的创作引擎，提供直观的自由画布界面，集成了多线程对话、知识库RAG（检索增强生成）集成、上下文记忆和智能搜索能力。作为一个开源项目，它采用现代化的技术栈构建，包括Nest.js后端和React前端。

开发环境准备

系统要求

在开始开发前，请确保您的系统满足以下基本要求：

Docker：版本20.10.0或更高，用于运行中间件服务
Node.js：推荐使用LTS版本20.19.0
包管理器：推荐使用pnpm（版本10.9.0或更高）

环境配置步骤

1. Node.js安装

建议使用nvm（Node版本管理器）来安装和管理Node.js版本：

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.2/install.sh | bash
source ~/.bashrc  # 如果使用zsh，改为source ~/.zshrc
nvm install 20.19.0

2. 验证依赖

安装完成后，请验证各依赖版本：

docker version
node -v  # 应显示v20.19.0
pnpm -v  # 应显示10.9.0或更高

3. 启用corepack

Corepack是Node.js内置的包管理器管理器：

corepack enable

项目启动流程

1. 启动中间件服务

Refly依赖多个中间件服务，使用Docker Compose可以一键启动：

docker compose -f deploy/docker/docker-compose.middleware.yml -p refly up -d

启动后，检查服务状态：

docker ps | grep refly_

2. 安装项目依赖

pnpm install

3. 配置环境变量

复制开发环境配置文件：

pnpm copy-env:develop

4. 启动开发服务器

pnpm build
pnpm dev

开发服务器启动后，可通过http://localhost:5173访问应用。

项目架构解析

后端架构

Refly后端采用Nest.js框架，主要模块包括：

AI核心功能：
- LLM集成与管理
- RAG管道实现
- 上下文记忆系统
画布服务：
- 状态管理
- 实时协作支持
API层：
- RESTful接口
- WebSocket实时通信

目录结构示例：

apps/server/
├── src/
│   ├── controllers/  # API路由处理器
│   ├── services/     # 业务逻辑实现
│   ├── ai/           # AI功能实现
│   │   ├── llm/      # 大语言模型集成
│   │   ├── rag/      # 检索增强生成
│   │   └── memory/   # 上下文记忆

前端架构

前端采用React构建，主要特点：

模块化组件设计
共享UI组件库
国际化支持
状态管理集成

目录结构示例：

apps/web/
├── src/
│   ├── components/  # React组件
│   ├── styles/      # 全局样式
packages/
├── ai-workspace-common/  # 共享组件库
│   ├── src/
│   │   ├── components/   # 画布和编辑器组件