由于时间不足，此仓库的开发目前处于暂停状态。更新将于六月底发布。

再次开始工作 ; ) 我目前非常忙碌，因此非常感谢大家的贡献和 Pull Request。

待办事项

• 删除对话时进行二次确认
• 记住用户偏好设置
• 主题切换器
• 加载/导出对话
• 语音输出与输入（例如 ElevenLabs；参考：https://github.com/cogentapps/chat-with-gpt）
• 文件加载功能，例如：https://github.com/mayooear/gpt4-pdf-chatbot-langchain
• 更完善的文档
• 使用 React 或更快速的后端语言？（新手可能会因此感到困惑并失去兴趣）

ChatGPT 克隆项目

欢迎改进代码或提出改进建议

快速入门

要开始使用该项目，您需要克隆仓库并设置一个虚拟环境。这将允许您安装所需的依赖项，而不会影响您系统范围内的 Python 安装。

前置条件

在设置虚拟环境之前，您需要在系统上安装 Python。您可以从官方网站下载 Python：https://www.python.org/downloads/

克隆仓库

运行以下命令以克隆仓库：

git clone https://github.com/xtekky/chatgpt-clone.git

设置虚拟环境

按照以下步骤设置虚拟环境：

1. 导航到项目的根目录。

cd chatgpt-clone

2. 运行以下命令创建一个新的虚拟环境：

python -m venv venv

3. 激活虚拟环境，运行以下命令：

source venv/bin/activate

如果您使用的是 fish shell，命令会略有不同：

source venv/bin/activate.fish

如果您在 Windows 上，命令也会有所不同：

venv\Scripts\activate

4. 安装所需的依赖项，运行以下命令：

pip install -r requirements.txt

配置应用程序

为了配置应用程序，可以通过环境变量或 config.json 文件设置一些属性。环境变量具有优先级。

字段	环境变量	config.json	示例
OpenAI API 密钥	OPENAI_API_KEY	openai_key	sk-...
OpenAI 基础 URL	OPENAI_API_BASE	openai_api_base	https://api.openai.com http://my-reverse-proxy/

如果需要通过反向代理（如 这个）来运行查询，可以使用基础 URL，该代理会将您的请求转发到 Azure 的 OpenAI 终端点。

运行应用程序

确保虚拟环境已激活后，运行以下命令以启动应用程序：

python run.py

Docker

运行 ChatGPT 克隆项目的最简单方法是使用 Docker：

docker-compose up

ChatGPT Clone 快速上手指南

环境准备

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

• Python: 版本建议 3.8 及以上。
  • 官网下载：https://www.python.org/downloads/
  • 国内加速：推荐使用清华源或阿里云镜像站下载 Python 安装包，或在后续 pip 安装时使用国内镜像。
• Git: 用于克隆代码仓库。
• Docker (可选): 如果您希望使用容器化部署，需安装 Docker 及 Docker Compose。

安装步骤

方法一：本地源码部署（推荐开发者）

1. 克隆仓库 打开终端，执行以下命令获取源代码：

   git clone https://github.com/xtekky/chatgpt-clone.git
   cd chatgpt-clone
   

2. 创建并激活虚拟环境 为避免依赖冲突，建议创建独立的 Python 虚拟环境：

   python -m venv venv
   

   激活环境（根据操作系统选择对应命令）：

   • Linux / macOS:

     source venv/bin/activate
     

     (注：若使用 fish shell，请运行 source venv/bin/activate.fish)
   • Windows:

     venv\Scripts\activate
     

3. 安装依赖 激活环境后，安装项目所需库。国内用户建议使用清华镜像源加速下载：

   pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
   

4. 配置应用 您需要配置 OpenAI API 密钥。可以通过环境变量或修改 config.json 文件（环境变量优先级更高）。

   • 方式 A：设置环境变量

     export OPENAI_API_KEY=sk-your-api-key-here
     export OPENAI_API_BASE=https://api.openai.com
     

     (注：如果您使用国内反向代理访问 OpenAI，请将 OPENAI_API_BASE 设置为代理地址，例如 http://my-reverse-proxy/)

   • 方式 B：修改 config.json 在项目根目录找到或创建 config.json，填入以下内容：

     {
       "openai_key": "sk-your-api-key-here",
       "openai_api_base": "https://api.openai.com"
     }
     

方法二：Docker 部署（最简便）

如果您已安装 Docker，可直接一键启动，无需配置本地 Python 环境：

docker-compose up

(注：使用前请确保已在 docker-compose.yml 或环境变量中配置好 OPENAI_API_KEY)

基本使用

完成上述安装和配置后，即可启动服务：

1. 启动应用 确保虚拟环境已激活（本地部署模式），运行：

   python run.py
   

2. 访问界面 终端显示服务启动成功后（通常监听在 http://127.0.0.1:5000 或类似端口），打开浏览器访问该地址。

3. 开始对话

   • 在网页界面中输入您的问题。
   • 系统将通过配置的 API Key 调用 OpenAI 接口并返回回答。
   • 支持切换主题、保存用户偏好等基础功能。

提示：本项目目前处于维护更新阶段，部分高级功能（如文件上传、语音交互）正在开发中，欢迎提交 PR 贡献代码。