Skip to content

Latest commit

 

History

History
150 lines (96 loc) · 4.78 KB

README-CN.md

File metadata and controls

150 lines (96 loc) · 4.78 KB
Raw
icon

ChatGPT Web

English / 简体中文

A commercially-viable ChatGpt web application built with React.

可部署商业化的 ChatGpt 网页应用。

Proxy Demo / Business Demo / Issues / Buy Me a Coffee

代理（proxy）演示 / 商业（business）演示 / 反馈 / 赞助我

Deploy to Vercel

cover cover

群组

🤖 主要功能

  • 用户系统可对使用进行相关限制
  • 精心设计的 UI，响应式设计。
  • 极快的首屏加载速度（~100kb）
  • 海量的内置 prompt 列表，来自中文和英文
  • 一键导出聊天记录，完整的 Markdown 支持
  • 支持自定义API地址（如：openAI / API2D）

🎮 开始使用

Node 环境

node 需要 ^16 || ^18 || ^19 版本（node >= 16），可以使用 nvm 管理本地多个 node 版本。

# 查看 node 版本
node -v

# 查看 npm 版本
npm -v

# 查看 yarn 版本
yarn -v

1.先 Fork 本项目，然后克隆到本地。

git clone https://github.com/zihjiang/ChatGpt-Web.git

2.安装依赖

yarn install

3.运行

yarn dev

4.打包

yarn build

⛺️ 环境变量

本项目大多数配置项都通过环境变量来设置。

VITE_APP_REQUEST_HOST

请求服务端的Host地址。

VITE_APP_TITLE

Chat Web 标题名称。

VITE_APP_LOGO

Chat Web Logo。

VITE_APP_MODE

应用模式可选：商业模式（business）代理模式（proxy）混合模式（mix）

VITE_APP_AI_BASE_URL

可在内置请求地址设置（如用户未设置自己的key则走这里）

VITE_APP_AI_KEYS

Api 请求使用的 key, 支持多个 key，以逗号分隔（,）

🚧 开发

强烈不建议在本地进行开发或者部署，由于一些技术原因，很难在本地配置好 OpenAI API 代理，除非你能保证可以直连 OpenAI 服务器。

本地开发

  1. 安装 nodejs 和 yarn，具体细节请询问 ChatGPT；
  2. 执行 yarn install && yarn dev 即可。

服务端

  1. 目前服务端还不完善所以暂时未开源
  2. 前端请求服务端的 接口文档 你们可以按照这个接口文档进行开发

🎯 部署

直接将打包好的 dist 目录上传到服务器即可。WEB项目暂时不直接访问 OpenAI API 所有不要求服务器地址。

Vercel

如果你将其托管在自己的 Vercel 服务器上，可点击 deploy 按钮来开始你的部署！

Deploy to Vercel

设置 Vercel 的指导
  1. 前往 vercel.com
  2. 点击 Log in
  3. 点击 Continue with GitHub 通过 GitHub 进行登录
  4. 登录 GitHub 并允许访问所有存储库（如果系统这样提示）
  5. Fork 这个仓库
  6. 返回到你的 Vercel dashboard
  7. 选择 Import Project
  8. 选择 Import Git Repository
  9. 选择 root 并将所有内容保持不变，并且只需添加名为 PAT_1 的环境变量（如图所示），其中将包含一个个人访问令牌（PAT），你可以在这里轻松创建（保留默认，并且只需要命名下，名字随便）
  10. 点击 deploy，这就完成了，查看你的域名就可使用 API 了！

🧘 贡献者

见项目贡献者列表

📋 开源协议

License MIT