FreedomGPT

这是 FreedomGPT 应用程序的官方仓库。它使用 Electron 和 React 构建，允许用户在本地运行 LLM 模型。

加入我们的 Discord 社区

加入我们的 Discord 服务器，获取最新更新并与社区互动。

如何贡献

前提条件

• Node.js
• Git

快速安装

git clone --recursive https://github.com/ohmplatform/FreedomGPT.git freedom-gpt
cd freedom-gpt
npx yarn install

构建 llama.cpp 库

macOS

cd llama.cpp
make

Windows

• 下载并安装 CMake：https://cmake.org/download/
• 运行以下命令：

cd llama.cpp
cmake .
cmake --build . --config Release

现在你应该会有一个包含 main.exe 文件的 Release 文件夹。你可以运行这个文件来测试聊天客户端。

运行应用

要运行应用，在项目根目录下终端中执行以下命令：

npx yarn start

更改端口

如果需要，可以在以下文件中更改端口： src/ports.ts

Linux 安装与设置指南

必需软件包

要开始使用，你需要安装几个必需的软件包。运行以下命令：

sudo apt install nodejs
sudo apt install yarn
sudo apt install git
sudo apt install make
sudo apt install g++
sudo apt install npm

构建项目

导航到项目目录并构建：

cd freedom-gpt/llama.cpp
make
cd ..
npm install
npm run
npm start

使用方法

使用 Liberty Edge 模型

你可以手动下载 Liberty Edge 模型，并从 AI 模型界面设置这些文件的路径。

矿工收益

要启用矿工收益，请按照以下步骤操作：

1. 从 xmrig.com/download 下载 XMRig Linux 静态版（仅 CPU）。
2. 解压压缩包，并将 xmrig 二进制文件复制到 freedom-gpt/miner/mac/fgptminer 目录：

# 假设你已将 xmrig 解压到当前目录
cp xmrig freedom-gpt/miner/mac/fgptminer

致谢

本项目使用了多个开源软件包和库，没有它们，本项目将无法实现：

“llama.cpp”——C++ 库。https://github.com/ggerganov/llama.cpp

Facebook Research 的 “LLAMA”——一种低延迟、大规模的近似最近邻搜索算法。https://github.com/facebookresearch/llama

“Chatbot UI”——https://github.com/mckaywrigley/chatbot-ui

我们谨向这些软件包的开发者及其贡献者表示感谢，感谢他们以开源许可协议将其作品公开。正是他们的贡献使我们能够构建一个更强大、更高效的项目。

许可证

请参阅 LICENSE 文件。

FreedomGPT 快速上手指南

FreedomGPT 是一款基于 Electron 和 React 构建的开源应用，允许用户在本地机器上运行大型语言模型（LLM），无需依赖云端服务。

环境准备

在开始之前，请确保您的系统已安装以下基础依赖：

• 操作系统：Windows, macOS, 或 Linux
• Node.js：下载地址 (建议使用 LTS 版本)
• Git：下载地址
• 包管理器：推荐使用 yarn (若未安装可通过 npm install -g yarn 获取)
• 编译工具 (用于构建底层推理引擎)：
  • macOS: 需安装 Xcode Command Line Tools (xcode-select --install)
  • Windows: 需安装 CMake 和 Visual Studio Build Tools
  • Linux: 需安装 make, g++, build-essential 等开发包

提示：国内用户若下载依赖较慢，可配置 npm/yarn 镜像源（如淘宝镜像）：

npm config set registry https://registry.npmmirror.com
yarn config set registry https://registry.npmmirror.com

安装步骤

1. 克隆项目

使用 Git 递归克隆仓库以包含子模块（llama.cpp）：

git clone --recursive https://github.com/ohmplatform/FreedomGPT.git freedom-gpt
cd freedom-gpt

2. 安装前端依赖

npx yarn install

3. 构建底层推理库 (llama.cpp)

根据操作系统选择对应的构建命令：

macOS:

cd llama.cpp
make
cd ..

Windows (PowerShell):

cd llama.cpp
cmake .
cmake --build . --config Release
cd ..

构建完成后，llama.cpp/Release 目录下应生成 main.exe。

Linux:

cd llama.cpp
make
cd ..

若缺少编译工具，请先执行：sudo apt install make g++ build-essential

基本使用

启动应用

在项目根目录执行以下命令启动开发服务器并运行应用：

npx yarn start

加载模型

1. 应用启动后，进入 AI Models 界面。
2. 手动下载 Liberty Edge 系列模型文件（通常为 .bin 或 .gguf 格式）。
3. 在界面中设置模型文件的本地路径即可开始对话。

高级功能：挖矿收益 (可选)

若需启用挖矿功能赚取收益：

1. 从 xmrig.com 下载 Linux Static CPU 版本。
2. 将解压后的 xmrig 二进制文件复制到指定目录：

cp xmrig freedom-gpt/miner/mac/fgptminer

(注：路径示例针对 macOS，Windows/Linux 用户请参照项目内的 miner 目录结构放置)