快速开始本地开发

本文档介绍了如何设置开发环境以构建和测试 FastGPT，。

前置依赖项 link

您需要在计算机上安装和配置以下依赖项才能构建 FastGPT：

• Git
• Docker（构建镜像）
• Node.js v18.17 / v20.x（版本尽量一样，可以使用nvm管理node版本）
• pnpm 版本 8.6.0 (目前官方的开发环境)
• make命令: 根据不同平台，百度安装 (官方是GNU Make 4.3)

开始本地开发 link

1. Fork 存储库 link

您需要 Fork 存储库。

2. 克隆存储库 link

克隆您在 GitHub 上 Fork 的存储库：

  git clone [email protected]:<github_username>/FastGPT.git
  

目录简要说明

1. projects 目录下为 FastGPT 应用代码。其中 app 为 FastGPT 核心应用。（后续可能会引入其他应用）
2. NextJS 框架前后端放在一起，API 服务位于 src/pages/api 目录内。
3. packages 目录为共用代码，通过 workspace 被注入到 projects 中，已配置 monorepo 自动注入，无需额外打包。

3. 安装数据库 link

第一次开发，需要先部署数据库，建议本地开发可以随便找一台 2C2G 的轻量小数据库实践，或者新建文件夹并配置相关文件用以运行docker。数据库部署教程：Docker 快速部署。部署完了，可以本地访问其数据库。

4. 初始配置 link

以下文件均在 projects/app 路径下。

1. 环境变量

复制.env.template文件，在同级目录下生成一个.env.local 文件，修改.env.local 里内容才是有效的变量。变量说明见 .env.template，主要需要修改API_KEY和数据库的地址与端口以及数据库账号的用户名和密码，具体配置需要和docker配置文件相同，其中用户名和密码如需修改需要修改docker配置文件、数据库和.env.local文件，不能只改一处。

2. config 配置文件

复制 data/config.json 文件，生成一个 data/config.local.json 配置文件，具体配置参数说明，可参考 config 配置说明

注意：json 配置文件不能包含注释，介绍中为了方便看才加入的注释

这个文件大部分时候不需要修改。只需要关注 systemEnv 里的参数：

• vectorMaxProcess: 向量生成最大进程，根据数据库和 key 的并发数来决定，通常单个 120 号，2c4g 服务器设置 10~15。
• qaMaxProcess: QA 生成最大进程
• pgHNSWEfSearch: PostgreSQL vector 索引参数，越大搜索精度越高但是速度越慢，具体可看 pgvector 官方说明。

5. 运行 link

可参考项目根目录下的 dev.md，第一次编译运行可能会有点慢，需要点耐心哦

  # 给自动化脚本代码执行权限(非 linux 系统, 可以手动执行里面的 postinstall.sh 文件内容)
chmod -R +x ./scripts/
# 代码根目录下执行，会安装根 package、projects 和 packages 内所有依赖
# 如果提示 isolate-vm 安装失败，可以参考：https://github.com/laverdet/isolated-vm?tab=readme-ov-file#requirements
pnpm i

# 非 Make 运行
cd projects/app
pnpm dev

# Make 运行
make dev name=app
  

6. 部署打包 link

  # Docker cmd: Build image, not proxy
docker build -f ./projects/app/Dockerfile -t registry.cn-hangzhou.aliyuncs.com/fastgpt/fastgpt:v4.8.1 . --build-arg name=app
# Make cmd: Build image, not proxy
make build name=app image=registry.cn-hangzhou.aliyuncs.com/fastgpt/fastgpt:v4.8.1

# Docker cmd: Build image with proxy
docker build -f ./projects/app/Dockerfile -t registry.cn-hangzhou.aliyuncs.com/fastgpt/fastgpt:v4.8.1 . --build-arg name=app --build-arg proxy=taobao
# Make cmd: Build image with proxy
make build name=app image=registry.cn-hangzhou.aliyuncs.com/fastgpt/fastgpt:v4.8.1 proxy=taobao
  

如果不使用 docker 打包，需要手动把 Dockerfile 里 run 阶段的内容全部手动执行一遍（非常不推荐）。

提交代码至开源仓库 link

1. 确保你的代码是 Fork FastGPT 仓库
2. 尽可能少量的提交代码，每次提交仅解决一个问题。
3. 向 FastGPT 的 main 分支提交一个 PR，提交请求后，FastGPT 团队/社区的其他人将与您一起审查它。

如果遇到问题，比如合并冲突或不知道如何打开拉取请求，请查看 GitHub 的拉取请求教程，了解如何解决合并冲突和其他问题。一旦您的 PR 被合并，您将自豪地被列为贡献者表中的一员。

QA link

本地数据库无法连接 link

1. 如果你是连接远程的数据库，先检查对应的端口是否开放。
2. 如果是本地运行的数据库，可尝试host改成localhost或127.0.0.1
3. 本地连接远程的 Mongo，需要增加 directConnection=true 参数，才能连接上副本集的数据库。
4. mongo使用mongocompass客户端进行连接测试和可视化管理。
5. pg使用navicat进行连接和管理。

sh ./scripts/postinstall.sh 没权限 link

FastGPT 在pnpm i后会执行postinstall脚本，用于自动生成ChakraUI的Type。如果没有权限，可以先执行chmod -R +x ./scripts/，再执行pnpm i。

仍不可行的话，可以手动执行./scripts/postinstall.sh里的内容。 如果是Windows下的话，可以使用git bash给postinstall脚本添加执行权限并执行sh脚本

TypeError: Cannot read properties of null (reading ‘useMemo’ ) link

删除所有的node_modules，用 Node18 重新 install 试试，可能最新的 Node 有问题。 本地开发流程：

1. 根目录: pnpm i
2. 复制 config.json -> config.local.json
3. 复制 .env.template -> .env.local
4. cd projects/app
5. pnpm dev

Error response from daemon: error while creating mount source path ‘XXX’: mkdir XXX: file exists link

这个错误可能是之前停止容器时有文件残留导致的，首先需要确认相关镜像都全部关闭，然后手动删除相关文件或者重启docker即可

加入社区 link

遇到困难了吗？有任何问题吗? 加入微信群与开发者和用户保持沟通。

代码结构说明 link

nextjs link

FastGPT 使用了 nextjs 的 page route 作为框架。为了区分好前后端代码，在目录分配上会分成 global, service, web 3个自目录，分别对应着 前后端共用、后端专用、前端专用的代码。

monorepo link

FastGPT 采用 pnpm workspace 方式构建 monorepo 项目，主要分为两个部分：

• projects/app - FastGPT 主项目
• packages/ - 子模块
  • global - 共用代码，通常是放一些前后端都能执行的函数、类型声明、常量。
  • service - 服务端代码
  • web - 前端代码
  • plugin - 工作流自定义插件的代码

领域驱动模式（DDD） link

FastGPT 在代码模块划分时，按DDD的思想进行划分，主要分为以下几个领域：

core - 核心功能（知识库，工作流，应用，对话） support - 支撑功能（用户体系，计费，鉴权等） common - 基础功能（日志管理，文件读写等）

.
├── .github                      // github 相关配置
├── .husky                       // 格式化配置
├── docSite                      // 文档
├── files                        // 一些外部文件，例如 docker-compose, helm
├── packages                     // 子包
│   ├── global                   // 前后端通用子包
│   ├── plugins                  // 工作流插件（需要自定义包时候使用到）
│   ├── service                  // 后端子包
│   └── web                      // 前端子包
├── projects
│   └── app                      // FastGPT 主项目
├── python                       // 存放一些模型代码，和 FastGPT 本身无关
└── scripts                      // 一些自动化脚本
    ├── icon                     // icon预览脚本，可以在顶层 pnpm initIcon(把svg写入到代码中), pnpm previewIcon（预览icon）
    └── postinstall.sh           // chakraUI自定义theme初始化 ts 类型
├── package.json                 // 顶层monorepo
├── pnpm-lock.yaml
├── pnpm-workspace.yaml          // monorepo 声明
├── Dockerfile
├── LICENSE
├── README.md
├── README_en.md
├── README_ja.md
├── dev.md