From acef3d5a901fe747c66696e15cc175e77a1026e5 Mon Sep 17 00:00:00 2001 From: FireInRain Date: Thu, 27 Apr 2023 07:22:32 +0000 Subject: [PATCH] update readme for vercel deploy --- README.md | 19 +++++++++++++------ README_CN.md | 19 ++++++++++++------- 2 files changed, 25 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 073c22a7b..dba7cd58b 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,9 @@ One-Click to deploy well-designed ChatGPT web UI on Vercel. [演示](https://chat-gpt-next-web.vercel.app/) / [反馈](https://github.com/Yidadaa/ChatGPT-Next-Web/issues) / [QQ 群](https://user-images.githubusercontent.com/16968934/234462588-e8eff256-f5ca-46ef-8f5f-d7db6d28735a.jpg) / [打赏开发者](https://user-images.githubusercontent.com/16968934/227772541-5bcd52d8-61b7-488c-a203-0330d8006e2b.jpg) -[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FYidadaa%2FChatGPT-Next-Web&env=OPENAI_API_KEY&env=CODE&project-name=chatgpt-next-web&repository-name=ChatGPT-Next-Web) +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fdgqyushen%2FChatGPT-Next-Web%2Ftree%2Faccess-token&project-name=chatgpt-next-web&repository-name=ChatGPT-Next-Web) -[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Yidadaa/ChatGPT-Next-Web) +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/dgqyushen/ChatGPT-Next-Web) ![cover](./docs/images/cover.png) @@ -78,10 +78,17 @@ One-Click to deploy well-designed ChatGPT web UI on Vercel. > [简体中文 > 如何开始使用](./README_CN.md#开始使用) -1. Get [OpenAI API Key](https://platform.openai.com/account/api-keys); +1. Get [OpenAI AccessToken str](https://chat.openai.com/api/auth/session); + 2. Click - [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FYidadaa%2FChatGPT-Next-Web&env=OPENAI_API_KEY&env=CODE&project-name=chatgpt-next-web&repository-name=ChatGPT-Next-Web), remember that `CODE` is your page password; -3. Enjoy :) + [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fdgqyushen%2FChatGPT-Next-Web%2Ftree%2Faccess-token&env=CODE&project-name=chatgpt-next-web&repository-name=ChatGPT-Next-Web), remember that `CODE` is your page password; +3. Or Click + [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fdgqyushen%2FChatGPT-Next-Web%2Ftree%2Faccess-token&project-name=chatgpt-next-web&repository-name=ChatGPT-Next-Web), For public access using; + +4. Open the size you deployed,and set the accessToken the the site. + +4. Enjoy :) + ## FAQ @@ -155,7 +162,7 @@ Specify OpenAI organization ID. > [简体中文 > 如何进行二次开发](./README_CN.md#开发) -[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Yidadaa/ChatGPT-Next-Web) +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/dgqyushen/ChatGPT-Next-Web) Before starting development, you must create a new `.env.local` file at project root, and place your api key into it: diff --git a/README_CN.md b/README_CN.md index 23dfee85a..b3b41f640 100644 --- a/README_CN.md +++ b/README_CN.md @@ -7,9 +7,9 @@ [演示 Demo](https://chat-gpt-next-web.vercel.app/) / [反馈 Issues](https://github.com/Yidadaa/ChatGPT-Next-Web/issues) / [加入 Discord](https://discord.gg/zrhvHCr79N) / [QQ 群](https://user-images.githubusercontent.com/16968934/228190818-7dd00845-e9b9-4363-97e5-44c507ac76da.jpeg) / [打赏开发者](https://user-images.githubusercontent.com/16968934/227772541-5bcd52d8-61b7-488c-a203-0330d8006e2b.jpg) / [Donate](#捐赠-donate-usdt) -[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FYidadaa%2FChatGPT-Next-Web&env=OPENAI_API_KEY&env=CODE&project-name=chatgpt-next-web&repository-name=ChatGPT-Next-Web) +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fdgqyushen%2FChatGPT-Next-Web%2Ftree%2Faccess-token&project-name=chatgpt-next-web&repository-name=ChatGPT-Next-Web) -[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Yidadaa/ChatGPT-Next-Web) +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/dgqyushen/ChatGPT-Next-Web) ![主界面](./docs/images/cover.png) @@ -27,11 +27,16 @@ ## 开始使用 -1. 准备好你的 [OpenAI API Key](https://platform.openai.com/account/api-keys); +1. 准备好你的 [OpenAI AccessToken str](https://chat.openai.com/api/auth/session); 2. 点击右侧按钮开始部署： - [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FYidadaa%2FChatGPT-Next-Web&env=OPENAI_API_KEY&env=CODE&project-name=chatgpt-next-web&repository-name=ChatGPT-Next-Web)，直接使用 Github 账号登录即可，记得在环境变量页填入 API Key 和[页面访问密码](#配置页面访问密码) CODE； -3. 部署完毕后，即可开始使用； -4. （可选）[绑定自定义域名](https://vercel.com/docs/concepts/projects/domains/add-a-domain)：Vercel 分配的域名 DNS 在某些区域被污染了，绑定自定义域名即可直连。 + [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fdgqyushen%2FChatGPT-Next-Web%2Ftree%2Faccess-token&env=CODE&project-name=chatgpt-next-web&repository-name=ChatGPT-Next-Web)，直接使用 Github 账号登录即可，记得在环境变量页[页面访问密码](#配置页面访问密码) CODE； +3. 或者点击右侧按钮开始部署: + [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fdgqyushen%2FChatGPT-Next-Web%2Ftree%2Faccess-token&project-name=chatgpt-next-web&repository-name=ChatGPT-Next-Web),供公共访问，不设置访问密码; + +4. 部署完毕后，即可开始使用； +5. （可选）[绑定自定义域名](https://vercel.com/docs/concepts/projects/domains/add-a-domain)：Vercel 分配的域名 DNS 在某些区域被污染了，绑定自定义域名即可直连。 + +6. 访问部署后的网站，在设置页面设置好accessToken，即可享用。 ## 保持更新 @@ -104,7 +109,7 @@ OpenAI 接口代理 URL，如果你手动配置了 openai 接口代理，请填 点击下方按钮，开始二次开发： -[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Yidadaa/ChatGPT-Next-Web) +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/dgqyushen/ChatGPT-Next-Web) 在开始写代码之前，需要在项目根目录新建一个 `.env.local` 文件，里面填入环境变量：