diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index eb83f7741..01fa35e82 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,7 +1,7 @@ --- name: Bug report about: Create a report to help us improve -title: '' +title: "[Bug] " labels: '' assignees: '' @@ -23,7 +23,7 @@ A clear and concise description of what you expected to happen. **Screenshots** If applicable, add screenshots to help explain your problem. -** Deployment +**Deployment** - [ ] Docker - [ ] Vercel - [ ] Server diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7d6..25c36ab67 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,7 +1,7 @@ --- name: Feature request about: Suggest an idea for this project -title: '' +title: "[Feature] " labels: '' assignees: '' diff --git a/.gitignore b/.gitignore index 0a3e52afa..37f6b9029 100644 --- a/.gitignore +++ b/.gitignore @@ -36,4 +36,7 @@ yarn-error.log* next-env.d.ts dev -public/prompts.json \ No newline at end of file +public/prompts.json + +.vscode +.idea \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json deleted file mode 100644 index bd3337f97..000000000 --- a/.vscode/settings.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "typescript.tsdk": "node_modules\\typescript\\lib", - "typescript.enablePromptUseWorkspaceTsdk": true -} \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..7712d9742 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +flynn.zhang@foxmail.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/README.md b/README.md index 40386a005..d47a38954 100644 --- a/README.md +++ b/README.md @@ -1,84 +1,82 @@
-预览 +icon

ChatGPT Next Web

-一键免费部署你的私人 ChatGPT 网页应用。 - One-Click to deploy your own ChatGPT web UI. -[演示 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) +一键免费部署你的私人 ChatGPT 网页应用。 + +[演示 Demo](https://chat-gpt-next-web.vercel.app/) / [反馈 Issues](https://github.com/Yidadaa/ChatGPT-Next-Web/issues) / [Join 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) [![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) [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Yidadaa/ChatGPT-Next-Web) -![主界面](./static/cover.png) +![cover](./docs/images/cover.png)
-## 主要功能 - -- 在 1 分钟内使用 Vercel **免费一键部署** -- 精心设计的 UI，响应式设计，支持深色模式 -- 极快的首屏加载速度（~100kb） -- 海量的内置 prompt 列表，来自[中文](https://github.com/PlexPt/awesome-chatgpt-prompts-zh)和[英文](https://github.com/f/awesome-chatgpt-prompts) -- 自动压缩上下文聊天记录，在节省 Token 的同时支持超长对话 -- 一键导出聊天记录，完整的 Markdown 支持 -- 拥有自己的域名？好上加好，绑定后即可在任何地方**无障碍**快速访问 - ## Features - **Deploy for free with one-click** on Vercel in under 1 minute -- Responsive design, and dark mode +- Responsive design, dark mode and PWA - Fast first screen loading speed (~100kb) - Awesome prompts powered by [awesome-chatgpt-prompts-zh](https://github.com/PlexPt/awesome-chatgpt-prompts-zh) and [awesome-chatgpt-prompts](https://github.com/f/awesome-chatgpt-prompts) - Automatically compresses chat history to support long conversations while also saving your tokens - One-click export all chat history with full Markdown support - I18n supported -## 开发计划 Roadmap +## Roadmap -- System Prompt: pin a user defined prompt as system prompt 为每个对话设置系统 Prompt [#138](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/138) -- User Prompt: user can edit and save custom prompts to prompt list 允许用户自行编辑内置 Prompt 列表 -- Self-host Model: support llama, alpaca, ChatGLM, BELLE etc. 支持自部署的大语言模型 -- Plugins: support network search, caculator, any other apis etc. 插件机制，支持联网搜索、计算器、调用其他平台 api [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165) +- [x] System Prompt: pin a user defined prompt as system prompt [#138](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/138) +- [ ] User Prompt: user can edit and save custom prompts to prompt list +- [ ] Desktop App with tauri +- [ ] Self-host Model: support llama, alpaca, ChatGLM, BELLE etc. +- [ ] Plugins: support network search, caculator, any other apis etc. [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165) -### 不会开发的功能 Not in Plan +### Not in Plan -- User login, accounts, cloud sync 用户登录、账号管理、消息云同步 -- UI text customize 界面文字自定义 +- User login, accounts, cloud sync +- UI text customize -## 开始使用 +## 主要功能 + +- 在 1 分钟内使用 Vercel **免费一键部署** +- 精心设计的 UI，响应式设计，支持深色模式，支持 PWA +- 极快的首屏加载速度（~100kb） +- 海量的内置 prompt 列表，来自[中文](https://github.com/PlexPt/awesome-chatgpt-prompts-zh)和[英文](https://github.com/f/awesome-chatgpt-prompts) +- 自动压缩上下文聊天记录，在节省 Token 的同时支持超长对话 +- 一键导出聊天记录，完整的 Markdown 支持 +- 拥有自己的域名？好上加好，绑定后即可在任何地方**无障碍**快速访问 + +## 开发计划 +- [x] 为每个对话设置系统 Prompt [#138](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/138) +- [ ] 允许用户自行编辑内置 Prompt 列表 +- [ ] 使用 tauri 打包桌面应用 +- [ ] 支持自部署的大语言模型 +- [ ] 插件机制，支持联网搜索、计算器、调用其他平台 api [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165) + +### 不会开发的功能 +- 界面文字自定义 +- 用户登录、账号管理、消息云同步 -1. 准备好你的 [OpenAI API Key](https://platform.openai.com/account/api-keys); -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； -3. 部署完毕后，即可开始使用； -4. （可选）[绑定自定义域名](https://vercel.com/docs/concepts/projects/domains/add-a-domain)：Vercel 分配的域名 DNS 在某些区域被污染了，绑定自定义域名即可直连。 ## Get Started +> [简体中文 > 如何开始使用](./README_CN.md#开始使用) 1. Get [OpenAI API Key](https://platform.openai.com/account/api-keys); 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); + [![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 :) -## 保持更新 Keep Updated +## FAQ +> [简体中文 > 常见问题](./docs/faq-cn.md) -如果你按照上述步骤一键部署了自己的项目，可能会发现总是提示“存在更新”的问题，这是由于 Vercel 会默认为你创建一个新项目而不是 fork 本项目，这会导致无法正确地检测更新。 -推荐你按照下列步骤重新部署： +We are sorry that there is currently no English version of the FAQ. English users can use translation tools to access the document. We look forward to receiving your PR for an English version of the documentation. -- 删除掉原先的 repo； -- fork 本项目； -- 前往 vercel 控制台，删除掉原先的 project，然后新建 project，选择你刚刚 fork 出来的项目重新进行部署即可； -- 在重新部署的过程中，请手动添加名为 `OPENAI_API_KEY` 的环境变量，并填入你的 api key 作为值。 - -本项目会持续更新，当你 Fork 项目之后，默认会每天自动同步上游代码，无需额外操作。 - -如果你想让手动立即更新，可以查看 [Github 的文档](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork) 了解如何让 fork 的项目与上游代码同步。 - -你可以 star/watch 本项目或者 follow 作者来及时获得新功能更新通知。 +## Keep Updated +> [简体中文 > 如何保持代码更新](./README_CN.md#保持更新) If you have deployed your own project with just one click following the steps above, you may encounter the issue of "Updates Available" constantly showing up. This is because Vercel will create a new project for you by default instead of forking this project, resulting in the inability to detect updates correctly. @@ -95,15 +93,8 @@ If you want to update instantly, you can check out the [Github documentation](ht You can star or watch this project or follow author to get release notifictions in time. -## 配置密码 Password - -本项目提供有限的权限控制功能，请在 Vercel 项目控制面板的环境变量页增加名为 `CODE` 的环境变量，值为用英文逗号分隔的自定义密码： - -``` -code1,code2,code3 -``` - -增加或修改该环境变量后，请**重新部署**项目使改动生效。 +## Access Password +> [简体中文 > 如何增加访问密码](./README_CN.md#配置页面访问密码) This project provides limited access control. Please add an environment variable named `CODE` on the vercel environment variables page. The value should be passwords separated by comma like this: @@ -113,26 +104,21 @@ code1,code2,code3 After adding or modifying this environment variable, please redeploy the project for the changes to take effect. -## 环境变量 Environment Variables +## Environment Variables +> [简体中文 > 如何配置 api key、访问密码、接口代理](./README_CN.md#环境变量) ### `OPENAI_API_KEY` (required) -OpanAI 密钥。 - Your openai api key. ### `CODE` (optional) -访问密码，可选，可以使用逗号隔开多个密码。 - Access passsword, separated by comma. ### `BASE_URL` (optional) > Default: `api.openai.com` -OpenAI 接口代理 URL。 - Override openai api request base url. ### `PROTOCOL` (optional) @@ -141,38 +127,32 @@ Override openai api request base url. > Values: `http` | `https` -OpenAI 接口协议。 - Override openai api request protocol. -## 开发 Development - -点击下方按钮，开始二次开发： +## Development +> [简体中文 > 如何进行二次开发](./README_CN.md#开发) [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Yidadaa/ChatGPT-Next-Web) -在开始写代码之前，需要在项目根目录新建一个 `.env.local` 文件，里面填入环境变量： - Before starting development, you must create a new `.env.local` file at project root, and place your api key into it: ``` OPENAI_API_KEY= ``` -### 本地开发 Local Development - -> 如果你是中国大陆用户，不建议在本地进行开发，除非你能够独立解决 OpenAI API 本地代理问题。 - -1. 安装 nodejs 和 yarn，具体细节请询问 ChatGPT； -2. 执行 `yarn install && yarn dev` 即可。 - -### 本地部署 Local Deployment +### Local Development ```shell -bash <(curl -s https://raw.githubusercontent.com/Yidadaa/ChatGPT-Next-Web/main/scripts/setup.sh) +# 1. install nodejs and yarn first +# 2. config local env vars in `.env.local` +# 3. run +yarn install +yarn dev ``` -### 容器部署 Docker Deployment +## Deployment +> [简体中文 > 如何部署到私人服务器](./README_CN.md#部署) +### Docker (Recommended) ```shell docker pull yidadaa/chatgpt-next-web @@ -180,22 +160,27 @@ docker pull yidadaa/chatgpt-next-web docker run -d -p 3000:3000 -e OPENAI_API_KEY="" -e CODE="" yidadaa/chatgpt-next-web ``` -## 截图 Screenshots +### Shell -![设置 Settings](./static/settings.png) +```shell +bash <(curl -s https://raw.githubusercontent.com/Yidadaa/ChatGPT-Next-Web/main/scripts/setup.sh) +``` +## Screenshots -![更多展示 More](./static/more.png) +![Settings](./docs/images/settings.png) + +![More](./docs/images/more.png) -## 鸣谢 Special Thanks -### 捐赠者 Sponsor +## Special Thanks +### Sponsor [@mushan0x0](https://github.com/mushan0x0) [@ClarenceDan](https://github.com/ClarenceDan) [@zhangjia](https://github.com/zhangjia) [@hoochanlon](https://github.com/hoochanlon) -### 贡献者 Contributor +### Contributor [Contributors](https://github.com/Yidadaa/ChatGPT-Next-Web/graphs/contributors) diff --git a/README_CN.md b/README_CN.md new file mode 100644 index 000000000..cba9df9c5 --- /dev/null +++ b/README_CN.md @@ -0,0 +1,144 @@ +
+预览 + +

ChatGPT Next Web

+ +一键免费部署你的私人 ChatGPT 网页应用。 + +[演示 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) + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Yidadaa/ChatGPT-Next-Web) + +![主界面](./static/cover.png) + +
+ +## 主要功能 + +- 在 1 分钟内使用 Vercel **免费一键部署** +- 精心设计的 UI，响应式设计，支持深色模式 +- 极快的首屏加载速度（~100kb） +- 海量的内置 prompt 列表，来自[中文](https://github.com/PlexPt/awesome-chatgpt-prompts-zh)和[英文](https://github.com/f/awesome-chatgpt-prompts) +- 自动压缩上下文聊天记录，在节省 Token 的同时支持超长对话 +- 一键导出聊天记录，完整的 Markdown 支持 +- 拥有自己的域名？好上加好，绑定后即可在任何地方**无障碍**快速访问 + +## 开始使用 + +1. 准备好你的 [OpenAI API Key](https://platform.openai.com/account/api-keys); +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； +3. 部署完毕后，即可开始使用； +4. （可选）[绑定自定义域名](https://vercel.com/docs/concepts/projects/domains/add-a-domain)：Vercel 分配的域名 DNS 在某些区域被污染了，绑定自定义域名即可直连。 + +## 保持更新 + +如果你按照上述步骤一键部署了自己的项目，可能会发现总是提示“存在更新”的问题，这是由于 Vercel 会默认为你创建一个新项目而不是 fork 本项目，这会导致无法正确地检测更新。 +推荐你按照下列步骤重新部署： + +- 删除掉原先的 repo； +- fork 本项目； +- 前往 vercel 控制台，删除掉原先的 project，然后新建 project，选择你刚刚 fork 出来的项目重新进行部署即可； +- 在重新部署的过程中，请手动添加名为 `OPENAI_API_KEY` 的环境变量，并填入你的 api key 作为值。 + +本项目会持续更新，当你 Fork 项目之后，默认会每天自动同步上游代码，无需额外操作。 + +如果你想让手动立即更新，可以查看 [Github 的文档](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork) 了解如何让 fork 的项目与上游代码同步。 + +你可以 star/watch 本项目或者 follow 作者来及时获得新功能更新通知。 + +## 配置页面访问密码 + +> 配置密码后，用户需要在设置页手动填写访问码才可以正常聊天，否则会通过消息提示未授权状态。 + +本项目提供有限的权限控制功能，请在 Vercel 项目控制面板的环境变量页增加名为 `CODE` 的环境变量，值为用英文逗号分隔的自定义密码： + +``` +code1,code2,code3 +``` + +增加或修改该环境变量后，请**重新部署**项目使改动生效。 + +## 环境变量 +> 本项目大多数配置项都通过环境变量来设置。 + +### `OPENAI_API_KEY` （必填项） + +OpanAI 密钥，你在 openai 账户页面申请的 api key。 + +### `CODE` （可选） + +访问密码，可选，可以使用逗号隔开多个密码。 + +**警告**：如果不填写此项，则任何人都可以直接使用你部署后的网站，可能会导致你的 token 被急速消耗完毕，建议填写此选项。 + +### `BASE_URL` （可选） + +> Default: `api.openai.com` + +OpenAI 接口代理 URL，如果你手动配置了 openai 接口代理，请填写此选项。 + +### `PROTOCOL` （可选） + +> Default: `https` + +> Values: `http` | `https` + +OpenAI 代理接口协议，如果遇到 ssl 证书问题，请尝试通过此选项设置为 http。 + +## 开发 + +> 强烈不建议在本地进行开发或者部署，由于一些技术原因，很难在本地配置好 OpenAI API 代理，除非你能保证可以直连 OpenAI 服务器。 + +点击下方按钮，开始二次开发： + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Yidadaa/ChatGPT-Next-Web) + +在开始写代码之前，需要在项目根目录新建一个 `.env.local` 文件，里面填入环境变量： + +``` +OPENAI_API_KEY= +``` + +### 本地开发 + +1. 安装 nodejs 和 yarn，具体细节请询问 ChatGPT； +2. 执行 `yarn install && yarn dev` 即可。 + +## 部署 +### 容器部署 （推荐） +> 注意：docker 版本在大多数时间都会落后最新的版本 1 到 2 天，所以部署后会持续出现“存在更新”的提示，属于正常现象。 + +```shell +docker pull yidadaa/chatgpt-next-web + +docker run -d -p 3000:3000 -e OPENAI_API_KEY="" -e CODE="" yidadaa/chatgpt-next-web +``` + +### 本地部署 +在控制台运行下方命令： + +```shell +bash <(curl -s https://raw.githubusercontent.com/Yidadaa/ChatGPT-Next-Web/main/scripts/setup.sh) +``` + + +## 鸣谢 +### 捐赠者 +> 仅列出了部分大额打赏，小额打赏（< 100RMB）人数太多，在此不再列出，敬请谅解。 + +[@mushan0x0](https://github.com/mushan0x0) +[@ClarenceDan](https://github.com/ClarenceDan) +[@zhangjia](https://github.com/zhangjia) +[@hoochanlon](https://github.com/hoochanlon) + +### 贡献者 + +[见项目贡献者列表](https://github.com/Yidadaa/ChatGPT-Next-Web/graphs/contributors) + +## 开源协议 +> 反对 996，从我开始。 + +[Anti 996 License](https://github.com/kattgu7/Anti-996-License/blob/master/LICENSE_CN_EN) diff --git a/app/api/chat-stream/route.ts b/app/api/chat-stream/route.ts index f33175543..526623ce1 100644 --- a/app/api/chat-stream/route.ts +++ b/app/api/chat-stream/route.ts @@ -53,6 +53,9 @@ export async function POST(req: NextRequest) { return new Response(stream); } catch (error) { console.error("[Chat Stream]", error); + return new Response( + ["```json\n", JSON.stringify(error, null, " "), "\n```"].join(""), + ); } } diff --git a/app/components/chat-list.tsx b/app/components/chat-list.tsx index 8ad2b7dc0..8d02805f7 100644 --- a/app/components/chat-list.tsx +++ b/app/components/chat-list.tsx @@ -1,14 +1,13 @@ -import { useState, useRef, useEffect, useLayoutEffect } from "react"; import DeleteIcon from "../icons/delete.svg"; import styles from "./home.module.scss"; - import { - Message, - SubmitKey, - useChatStore, - ChatSession, - BOT_HELLO, -} from "../store"; + DragDropContext, + Droppable, + Draggable, + OnDragEndResponder, +} from "@hello-pangea/dnd"; + +import { useChatStore } from "../store"; import Locale from "../locales"; import { isMobileScreen } from "../utils"; @@ -20,54 +19,92 @@ export function ChatItem(props: { count: number; time: string; selected: boolean; + id: number; + index: number; }) { return ( -
-
{props.title}
-
-
- {Locale.ChatItem.ChatItemCount(props.count)} + + {(provided) => ( +
+
{props.title}
+
+
+ {Locale.ChatItem.ChatItemCount(props.count)} +
+
{props.time}
+
+
+ +
-
{props.time}
-
-
- -
-
+ )} + ); } export function ChatList() { - const [sessions, selectedIndex, selectSession, removeSession] = useChatStore( - (state) => [ + const [sessions, selectedIndex, selectSession, removeSession, moveSession] = + useChatStore((state) => [ state.sessions, state.currentSessionIndex, state.selectSession, state.removeSession, - ], - ); + state.moveSession, + ]); + + const onDragEnd: OnDragEndResponder = (result) => { + const { destination, source } = result; + if (!destination) { + return; + } + + if ( + destination.droppableId === source.droppableId && + destination.index === source.index + ) { + return; + } + + moveSession(source.index, destination.index); + }; return ( -
- {sessions.map((item, i) => ( - selectSession(i)} - onDelete={() => - (!isMobileScreen() || confirm(Locale.Home.DeleteChat)) && - removeSession(i) - } - /> - ))} -
+ + + {(provided) => ( +
+ {sessions.map((item, i) => ( + selectSession(i)} + onDelete={() => + (!isMobileScreen() || confirm(Locale.Home.DeleteChat)) && + removeSession(i) + } + /> + ))} + {provided.placeholder} +
+ )} + + ); } diff --git a/app/components/chat.module.scss b/app/components/chat.module.scss index 5216fb255..f57e6c100 100644 --- a/app/components/chat.module.scss +++ b/app/components/chat.module.scss @@ -63,6 +63,14 @@ font-size: 12px; font-weight: bold; margin-bottom: 10px; + display: flex; + justify-content: space-between; + align-items: center; + + .memory-prompt-action { + display: flex; + align-items: center; + } } .memory-prompt-content { diff --git a/app/components/chat.tsx b/app/components/chat.tsx index 52307078d..90c88d97b 100644 --- a/app/components/chat.tsx +++ b/app/components/chat.tsx @@ -12,7 +12,14 @@ import BotIcon from "../icons/bot.svg"; import AddIcon from "../icons/add.svg"; import DeleteIcon from "../icons/delete.svg"; -import { Message, SubmitKey, useChatStore, BOT_HELLO, ROLES } from "../store"; +import { + Message, + SubmitKey, + useChatStore, + BOT_HELLO, + ROLES, + createMessage, +} from "../store"; import { copyToClipboard, @@ -32,11 +39,14 @@ import { IconButton } from "./button"; import styles from "./home.module.scss"; import chatStyle from "./chat.module.scss"; -import { Modal, showModal, showToast } from "./ui-lib"; +import { Input, Modal, showModal, showToast } from "./ui-lib"; -const Markdown = dynamic(async () => memo((await import("./markdown")).Markdown), { - loading: () => , -}); +const Markdown = dynamic( + async () => memo((await import("./markdown")).Markdown), + { + loading: () => , + }, +); const Emoji = dynamic(async () => (await import("emoji-picker-react")).Emoji, { loading: () => , @@ -141,6 +151,16 @@ function PromptToast(props: { title={Locale.Context.Edit} onClose={() => props.setShowModal(false)} actions={[ + } + bordered + text={Locale.Memory.Reset} + onClick={() => + confirm(Locale.Memory.ResetConfirm) && + chatStore.resetSession() + } + />, } @@ -151,7 +171,6 @@ function PromptToast(props: { ]} > <> - {" "}
{context.map((c, i) => (
@@ -171,17 +190,18 @@ function PromptToast(props: { ))} - + rows={1} + onInput={(e) => updateContextPrompt(i, { ...c, - content: e.target.value as any, + content: e.currentTarget.value as any, }) } - > + /> } className={chatStyle["context-delete-button"]} @@ -209,8 +229,24 @@ function PromptToast(props: {
- {Locale.Memory.Title} ({session.lastSummarizeIndex} of{" "} - {session.messages.length}) + + {Locale.Memory.Title} ({session.lastSummarizeIndex} of{" "} + {session.messages.length}) + + +
{session.memoryPrompt || Locale.Memory.EmptyContent} @@ -378,8 +414,8 @@ export function Chat(props: { }; // stop response - const onUserStop = (messageIndex: number) => { - ControllerPool.stop(sessionIndex, messageIndex); + const onUserStop = (messageId: number) => { + ControllerPool.stop(sessionIndex, messageId); }; // check if should send message @@ -409,6 +445,9 @@ export function Chat(props: { chatStore .onUserInput(messages[i].content) .then(() => setIsLoading(false)); + chatStore.updateCurrentSession((session) => + session.messages.splice(i, 2), + ); inputRef.current?.focus(); return; } @@ -433,9 +472,10 @@ export function Chat(props: { isLoading ? [ { - role: "assistant", - content: "……", - date: new Date().toLocaleString(), + ...createMessage({ + role: "assistant", + content: "……", + }), preview: true, }, ] @@ -445,9 +485,10 @@ export function Chat(props: { userInput.length > 0 && config.sendPreviewBubble ? [ { - role: "user", - content: userInput, - date: new Date().toLocaleString(), + ...createMessage({ + role: "user", + content: userInput, + }), preview: true, }, ] @@ -460,6 +501,7 @@ export function Chat(props: { useEffect(() => { if (props.sideBarShowing && isMobileScreen()) return; inputRef.current?.focus(); + // eslint-disable-next-line react-hooks/exhaustive-deps }, []); return ( @@ -563,7 +605,7 @@ export function Chat(props: { {message.streaming ? (
onUserStop(i)} + onClick={() => onUserStop(message.id ?? i)} > {Locale.Chat.Actions.Stop}
diff --git a/app/components/home.module.scss b/app/components/home.module.scss index 64ac2363f..da954dc1d 100644 --- a/app/components/home.module.scss +++ b/app/components/home.module.scss @@ -125,7 +125,7 @@ border-radius: 10px; margin-bottom: 10px; box-shadow: var(--card-shadow); - transition: all 0.3s ease; + transition: background-color 0.3s ease; cursor: pointer; user-select: none; border: 2px solid transparent; diff --git a/app/components/home.tsx b/app/components/home.tsx index 0bf568463..b4a0949c6 100644 --- a/app/components/home.tsx +++ b/app/components/home.tsx @@ -19,7 +19,6 @@ import CloseIcon from "../icons/close.svg"; import { useChatStore } from "../store"; import { isMobileScreen } from "../utils"; import Locale from "../locales"; -import { ChatList } from "./chat-list"; import { Chat } from "./chat"; import dynamic from "next/dynamic"; @@ -39,6 +38,10 @@ const Settings = dynamic(async () => (await import("./settings")).Settings, { loading: () => , }); +const ChatList = dynamic(async () => (await import("./chat-list")).ChatList, { + loading: () => , +}); + function useSwitchTheme() { const config = useChatStore((state) => state.config); diff --git a/app/components/settings.tsx b/app/components/settings.tsx index b563d7bab..a14f6473d 100644 --- a/app/components/settings.tsx +++ b/app/components/settings.tsx @@ -96,26 +96,18 @@ export function Settings(props: { closeSettings: () => void }) { const [usage, setUsage] = useState<{ used?: number; + subscription?: number; }>(); const [loadingUsage, setLoadingUsage] = useState(false); function checkUsage() { setLoadingUsage(true); requestUsage() - .then((res) => - setUsage({ - used: res, - }), - ) + .then((res) => setUsage(res)) .finally(() => { setLoadingUsage(false); }); } - useEffect(() => { - checkUpdate(); - // eslint-disable-next-line react-hooks/exhaustive-deps - }, []); - const accessStore = useAccessStore(); const enabledAccessControl = useMemo( () => accessStore.enabledAccessControl(), @@ -127,12 +119,13 @@ export function Settings(props: { closeSettings: () => void }) { const builtinCount = SearchService.count.builtin; const customCount = promptStore.prompts.size ?? 0; - const showUsage = accessStore.token !== ""; + const showUsage = !!accessStore.token || !!accessStore.accessCode; + useEffect(() => { - if (showUsage) { - checkUsage(); - } - }, [showUsage]); + checkUpdate(); + showUsage && checkUsage(); + // eslint-disable-next-line react-hooks/exhaustive-deps + }, []); return ( @@ -392,7 +385,10 @@ export function Settings(props: { closeSettings: () => void }) { showUsage ? loadingUsage ? Locale.Settings.Usage.IsChecking - : Locale.Settings.Usage.SubTitle(usage?.used ?? "[?]") + : Locale.Settings.Usage.SubTitle( + usage?.used ?? "[?]", + usage?.subscription ?? "[?]", + ) : Locale.Settings.Usage.NoAccess } > diff --git a/app/components/ui-lib.module.scss b/app/components/ui-lib.module.scss index c3ebcc02c..10163e993 100644 --- a/app/components/ui-lib.module.scss +++ b/app/components/ui-lib.module.scss @@ -141,6 +141,16 @@ } } +.input { + border: var(--border-in-light); + border-radius: 10px; + padding: 10px; + font-family: inherit; + background-color: var(--white); + color: var(--black); + resize: none; +} + @media only screen and (max-width: 600px) { .modal-container { width: 90vw; diff --git a/app/components/ui-lib.tsx b/app/components/ui-lib.tsx index b516b1810..6761e7f97 100644 --- a/app/components/ui-lib.tsx +++ b/app/components/ui-lib.tsx @@ -2,6 +2,7 @@ import styles from "./ui-lib.module.scss"; import LoadingIcon from "../icons/three-dots.svg"; import CloseIcon from "../icons/close.svg"; import { createRoot } from "react-dom/client"; +import React from "react"; export function Popover(props: { children: JSX.Element; @@ -140,3 +141,17 @@ export function showToast(content: string, delay = 3000) { root.render(); } + +export type InputProps = React.HTMLProps & { + autoHeight?: boolean; + rows?: number; +}; + +export function Input(props: InputProps) { + return ( + + ); +} diff --git a/app/constant.ts b/app/constant.ts index 169a5eee5..8a519d44e 100644 --- a/app/constant.ts +++ b/app/constant.ts @@ -2,6 +2,6 @@ export const OWNER = "Yidadaa"; export const REPO = "ChatGPT-Next-Web"; export const REPO_URL = `https://github.com/${OWNER}/${REPO}`; export const ISSUE_URL = `https://github.com/${OWNER}/${REPO}/issues`; -export const UPDATE_URL = `${REPO_URL}#%E4%BF%9D%E6%8C%81%E6%9B%B4%E6%96%B0-keep-updated`; +export const UPDATE_URL = `${REPO_URL}#keep-updated`; export const FETCH_COMMIT_URL = `https://api.github.com/repos/${OWNER}/${REPO}/commits?per_page=1`; export const FETCH_TAG_URL = `https://api.github.com/repos/${OWNER}/${REPO}/tags?per_page=1`; diff --git a/app/locales/cn.ts b/app/locales/cn.ts index e0adb6dc6..033e1c2cf 100644 --- a/app/locales/cn.ts +++ b/app/locales/cn.ts @@ -3,7 +3,7 @@ import { SubmitKey } from "../store/app"; const cn = { WIP: "该功能仍在开发中……", Error: { - Unauthorized: "现在是未授权状态，请在设置页输入授权码。", + Unauthorized: "现在是未授权状态，请在设置页输入访问密码。", }, ChatItem: { ChatItemCount: (count: number) => `${count} 条对话`, @@ -39,7 +39,10 @@ const cn = { Memory: { Title: "历史记忆", EmptyContent: "尚未记忆", - Copy: "全部复制", + Send: "发送记忆", + Copy: "复制记忆", + Reset: "重置对话", + ResetConfirm: "重置后将清空当前对话记录以及历史记忆，确认重置？", }, Home: { NewChat: "新的聊天", @@ -101,22 +104,22 @@ const cn = { }, Token: { Title: "API Key", - SubTitle: "使用自己的 Key 可绕过授权访问限制", + SubTitle: "使用自己的 Key 可绕过密码访问限制", Placeholder: "OpenAI API Key", }, Usage: { - Title: "账户余额", - SubTitle(used: any) { - return `本月已使用 $${used}`; + Title: "余额查询", + SubTitle(used: any, total: any) { + return `本月已使用 $${used}，订阅总额 $${total}`; }, IsChecking: "正在检查…", Check: "重新检查", - NoAccess: "输入API Key查看余额", + NoAccess: "输入 API Key 或访问密码查看余额", }, AccessCode: { - Title: "授权码", + Title: "访问密码", SubTitle: "现在是未授权访问状态", - Placeholder: "请输入授权码", + Placeholder: "请输入访问密码", }, Model: "模型 (model)", Temperature: { diff --git a/app/locales/en.ts b/app/locales/en.ts index af8201503..aefc2e57c 100644 --- a/app/locales/en.ts +++ b/app/locales/en.ts @@ -41,7 +41,11 @@ const en: LocaleType = { Memory: { Title: "Memory Prompt", EmptyContent: "Nothing yet.", - Copy: "Copy All", + Send: "Send Memory", + Copy: "Copy Memory", + Reset: "Reset Session", + ResetConfirm: + "Resetting will clear the current conversation history and historical memory. Are you sure you want to reset?", }, Home: { NewChat: "New Chat", @@ -108,8 +112,8 @@ const en: LocaleType = { }, Usage: { Title: "Account Balance", - SubTitle(used: any) { - return `Used this month $${used}`; + SubTitle(used: any, total: any) { + return `Used this month $${used}, subscription $${total}`; }, IsChecking: "Checking...", Check: "Check Again", diff --git a/app/locales/es.ts b/app/locales/es.ts index 5c73b608b..6997d5f6d 100644 --- a/app/locales/es.ts +++ b/app/locales/es.ts @@ -42,6 +42,10 @@ const es: LocaleType = { Title: "Historial de memoria", EmptyContent: "Aún no hay nada.", Copy: "Copiar todo", + Send: "Send Memory", + Reset: "Reset Session", + ResetConfirm: + "Resetting will clear the current conversation history and historical memory. Are you sure you want to reset?", }, Home: { NewChat: "Nuevo chat", @@ -108,8 +112,8 @@ const es: LocaleType = { }, Usage: { Title: "Saldo de la cuenta", - SubTitle(used: any) { - return `Usado $${used}`; + SubTitle(used: any, total: any) { + return `Usado $${used}, subscription $${total}`; }, IsChecking: "Comprobando...", Check: "Comprobar de nuevo", diff --git a/app/locales/it.ts b/app/locales/it.ts index ce87796d1..95e6747ba 100644 --- a/app/locales/it.ts +++ b/app/locales/it.ts @@ -42,6 +42,10 @@ const it: LocaleType = { Title: "Prompt di memoria", EmptyContent: "Vuoto.", Copy: "Copia tutto", + Send: "Send Memory", + Reset: "Reset Session", + ResetConfirm: + "Resetting will clear the current conversation history and historical memory. Are you sure you want to reset?", }, Home: { NewChat: "Nuova Chat", @@ -109,8 +113,8 @@ const it: LocaleType = { }, Usage: { Title: "Bilancio Account", - SubTitle(used: any) { - return `Usato in questo mese $${used}`; + SubTitle(used: any, total: any) { + return `Usato in questo mese $${used}, subscription $${total}`; }, IsChecking: "Controllando...", Check: "Controlla ancora", diff --git a/app/locales/tw.ts b/app/locales/tw.ts index eaab03fcd..4340fe2c8 100644 --- a/app/locales/tw.ts +++ b/app/locales/tw.ts @@ -41,6 +41,9 @@ const tw: LocaleType = { Title: "上下文記憶 Prompt", EmptyContent: "尚未記憶", Copy: "複製全部", + Send: "發送記憶", + Reset: "重置對話", + ResetConfirm: "重置後將清空當前對話記錄以及歷史記憶，確認重置？", }, Home: { NewChat: "新的對話", @@ -106,8 +109,8 @@ const tw: LocaleType = { }, Usage: { Title: "帳戶餘額", - SubTitle(used: any) { - return `本月已使用 $${used}`; + SubTitle(used: any, total: any) { + return `本月已使用 $${used}，订阅总额 $${total}`; }, IsChecking: "正在檢查…", Check: "重新檢查", diff --git a/app/requests.ts b/app/requests.ts index da9b5c97f..8462f2694 100644 --- a/app/requests.ts +++ b/app/requests.ts @@ -1,6 +1,5 @@ import type { ChatRequest, ChatReponse } from "./api/openai/typing"; -import { Message, ModelConfig, useAccessStore } from "./store"; -import Locale from "./locales"; +import { Message, ModelConfig, useAccessStore, useChatStore } from "./store"; import { showToast } from "./components/ui-lib"; const TIME_OUT_MS = 30000; @@ -21,10 +20,12 @@ const makeRequestParam = ( sendMessages = sendMessages.filter((m) => m.role !== "assistant"); } + const modelConfig = useChatStore.getState().config.modelConfig; + return { - model: "gpt-3.5-turbo", messages: sendMessages, stream: options?.stream, + ...modelConfig, }; }; @@ -81,31 +82,39 @@ export async function requestUsage() { const startOfMonth = new Date(now.getFullYear(), now.getMonth(), 1); const startDate = formatDate(startOfMonth); const endDate = formatDate(now); - const res = await requestOpenaiClient( - `dashboard/billing/usage?start_date=${startDate}&end_date=${endDate}`, - )(null, "GET"); - try { - const response = (await res.json()) as { - total_usage: number; - error?: { - type: string; - message: string; - }; + const [used, subs] = await Promise.all([ + requestOpenaiClient( + `dashboard/billing/usage?start_date=${startDate}&end_date=${endDate}`, + )(null, "GET"), + requestOpenaiClient("dashboard/billing/subscription")(null, "GET"), + ]); + + const response = (await used.json()) as { + total_usage?: number; + error?: { + type: string; + message: string; }; + }; - if (response.error && response.error.type) { - showToast(response.error.message); - return; - } + const total = (await subs.json()) as { + hard_limit_usd?: number; + }; - if (response.total_usage) { - response.total_usage = Math.round(response.total_usage) / 100; - } - return response.total_usage; - } catch (error) { - console.error("[Request usage] ", error, res.body); + if (response.error && response.error.type) { + showToast(response.error.message); + return; } + + if (response.total_usage) { + response.total_usage = Math.round(response.total_usage) / 100; + } + + return { + used: response.total_usage, + subscription: total.hard_limit_usd, + }; } export async function requestChatStream( @@ -204,23 +213,22 @@ export const ControllerPool = { addController( sessionIndex: number, - messageIndex: number, + messageId: number, controller: AbortController, ) { - const key = this.key(sessionIndex, messageIndex); + const key = this.key(sessionIndex, messageId); this.controllers[key] = controller; return key; }, - stop(sessionIndex: number, messageIndex: number) { - const key = this.key(sessionIndex, messageIndex); + stop(sessionIndex: number, messageId: number) { + const key = this.key(sessionIndex, messageId); const controller = this.controllers[key]; - console.log(controller); controller?.abort(); }, - remove(sessionIndex: number, messageIndex: number) { - const key = this.key(sessionIndex, messageIndex); + remove(sessionIndex: number, messageId: number) { + const key = this.key(sessionIndex, messageId); delete this.controllers[key]; }, diff --git a/app/store/app.ts b/app/store/app.ts index d01e3cdd5..c63fa9d4f 100644 --- a/app/store/app.ts +++ b/app/store/app.ts @@ -15,8 +15,19 @@ export type Message = ChatCompletionResponseMessage & { date: string; streaming?: boolean; isError?: boolean; + id?: number; }; +export function createMessage(override: Partial): Message { + return { + id: Date.now(), + date: new Date().toLocaleString(), + role: "user", + content: "", + ...override, + }; +} + export enum SubmitKey { Enter = "Enter", CtrlEnter = "Ctrl + Enter", @@ -149,6 +160,7 @@ export interface ChatStat { export interface ChatSession { id: number; topic: string; + sendMemory: boolean; memoryPrompt: string; context: Message[]; messages: Message[]; @@ -158,11 +170,10 @@ export interface ChatSession { } const DEFAULT_TOPIC = Locale.Store.DefaultTopic; -export const BOT_HELLO: Message = { +export const BOT_HELLO: Message = createMessage({ role: "assistant", content: Locale.Store.BotHello, - date: "", -}; +}); function createEmptySession(): ChatSession { const createDate = new Date().toLocaleString(); @@ -170,6 +181,7 @@ function createEmptySession(): ChatSession { return { id: Date.now(), topic: DEFAULT_TOPIC, + sendMemory: true, memoryPrompt: "", context: [], messages: [], @@ -189,6 +201,7 @@ interface ChatStore { currentSessionIndex: number; clearSessions: () => void; removeSession: (index: number) => void; + moveSession: (from: number, to: number) => void; selectSession: (index: number) => void; newSession: () => void; currentSession: () => ChatSession; @@ -202,6 +215,7 @@ interface ChatStore { messageIndex: number, updater: (message?: Message) => void, ) => void; + resetSession: () => void; getMessagesWithMemory: () => Message[]; getMemoryPrompt: () => Message; @@ -278,6 +292,31 @@ export const useChatStore = create()( }); }, + moveSession(from: number, to: number) { + set((state) => { + const { sessions, currentSessionIndex: oldIndex } = state; + + // move the session + const newSessions = [...sessions]; + const session = newSessions[from]; + newSessions.splice(from, 1); + newSessions.splice(to, 0, session); + + // modify current session id + let newIndex = oldIndex === from ? to : oldIndex; + if (oldIndex > from && oldIndex <= to) { + newIndex -= 1; + } else if (oldIndex < from && oldIndex >= to) { + newIndex += 1; + } + + return { + currentSessionIndex: newIndex, + sessions: newSessions, + }; + }); + }, + newSession() { set((state) => ({ currentSessionIndex: 0, @@ -308,18 +347,15 @@ export const useChatStore = create()( }, async onUserInput(content) { - const userMessage: Message = { + const userMessage: Message = createMessage({ role: "user", content, - date: new Date().toLocaleString(), - }; + }); - const botMessage: Message = { - content: "", + const botMessage: Message = createMessage({ role: "assistant", - date: new Date().toLocaleString(), streaming: true, - }; + }); // get recent messages const recentMessages = get().getMessagesWithMemory(); @@ -342,7 +378,10 @@ export const useChatStore = create()( botMessage.streaming = false; botMessage.content = content; get().onNewMessage(botMessage); - ControllerPool.remove(sessionIndex, messageIndex); + ControllerPool.remove( + sessionIndex, + botMessage.id ?? messageIndex, + ); } else { botMessage.content = content; set(() => ({})); @@ -358,13 +397,13 @@ export const useChatStore = create()( userMessage.isError = true; botMessage.isError = true; set(() => ({})); - ControllerPool.remove(sessionIndex, messageIndex); + ControllerPool.remove(sessionIndex, botMessage.id ?? messageIndex); }, onController(controller) { // collect controller for stop/retry ControllerPool.addController( sessionIndex, - messageIndex, + botMessage.id ?? messageIndex, controller, ); }, @@ -391,7 +430,11 @@ export const useChatStore = create()( const context = session.context.slice(); - if (session.memoryPrompt && session.memoryPrompt.length > 0) { + if ( + session.sendMemory && + session.memoryPrompt && + session.memoryPrompt.length > 0 + ) { const memoryPrompt = get().getMemoryPrompt(); context.push(memoryPrompt); } @@ -415,6 +458,13 @@ export const useChatStore = create()( set(() => ({ sessions })); }, + resetSession() { + get().updateCurrentSession((session) => { + session.messages = []; + session.memoryPrompt = ""; + }); + }, + summarizeSession() { const session = get().currentSession(); @@ -427,7 +477,8 @@ export const useChatStore = create()( requestWithPrompt(session.messages, Locale.Store.Prompt.Topic).then( (res) => { get().updateCurrentSession( - (session) => (session.topic = trimTopic(res)), + (session) => + (session.topic = res ? trimTopic(res) : DEFAULT_TOPIC), ); }, ); @@ -506,7 +557,7 @@ export const useChatStore = create()( }), { name: LOCAL_KEY, - version: 1.1, + version: 1.2, migrate(persistedState, version) { const state = persistedState as ChatStore; @@ -514,6 +565,10 @@ export const useChatStore = create()( state.sessions.forEach((s) => (s.context = [])); } + if (version < 1.2) { + state.sessions.forEach((s) => (s.sendMemory = true)); + } + return state; }, }, diff --git a/app/styles/globals.scss b/app/styles/globals.scss index 48f56995b..6492b000a 100644 --- a/app/styles/globals.scss +++ b/app/styles/globals.scss @@ -126,6 +126,10 @@ select { text-align: center; } +label { + cursor: pointer; +} + input { text-align: center; } diff --git a/app/utils.ts b/app/utils.ts index 89084a7a0..9fcb11820 100644 --- a/app/utils.ts +++ b/app/utils.ts @@ -3,7 +3,7 @@ import { showToast } from "./components/ui-lib"; import Locale from "./locales"; export function trimTopic(topic: string) { - return topic.replace(/[，。！？、,.!?]*$/, ""); + return topic.replace(/[，。！？”“"、,.!?]*$/, ""); } export async function copyToClipboard(text: string) { diff --git a/docs/faq-cn.md b/docs/faq-cn.md new file mode 100644 index 000000000..2b7b45871 --- /dev/null +++ b/docs/faq-cn.md @@ -0,0 +1,52 @@ +# 常见问题 +> We are sorry that there is currently no English version of the FAQ. English users can use translation tools to access this document. We look forward to receiving your PR for an English version of the documentation. + + + +## 如何修改 Vercel 环境变量 +- 进入 vercel 的控制台页面； +- 选中你的 chatgpt next web 项目； +- 点击页面头部的 Settings 选项； +- 找到侧边栏的 Environment Variables 选项； +- 修改对应的值即可。 + + + +## 为什么我部署的版本没有流式响应 +> 相关讨论：[#386](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/386) + +如果你使用 ngnix 反向代理，需要在配置文件中增加下列代码： +``` +# 不缓存，支持流式输出 +proxy_cache off; # 关闭缓存 +proxy_buffering off; # 关闭代理缓冲 +chunked_transfer_encoding on; # 开启分块传输编码 +tcp_nopush on; # 开启TCP NOPUSH选项，禁止Nagle算法 +tcp_nodelay on; # 开启TCP NODELAY选项，禁止延迟ACK算法 +keepalive_timeout 300; # 设定keep-alive超时时间为65秒 +``` + +如果你是在 netlify 部署，此问题依然等待解决，请耐心等待。 + + + +## 为什么会一直提示“出错了，稍后重试吧” +原因可能有很多，请依次排查： +- 请先检查你的代码版本是否为最新版本，更新到最新版本后重试； +- 请检查 api key 是否设置正确，环境变量名称必须为全大写加下划线； +- 请检查 api key 是否可用； +- 如果经历了上述步骤依旧无法确定问题，请在 issue 区提交一个新 issue，并附上 vercel 的 runtime log 或者 docker 运行时的 log。 + + + +## 为什么 Docker 部署版本一直提示更新 +Docker 版本相当于稳定版，latest Docker 总是与 latest release version 一致，目前我们的发版频率是一到两天发一次，所以 Docker 版本会总是落后最新的提交一到两天，这在预期内。 + + + + +## 为什么 ChatGPT 的回复会乱码 +设置界面 - 模型设置项中，有一项为 `temperature`，如果此值大于 1，那么就有可能造成回复乱码，将其调回 1 以内即可。 + +## 如何使用 Azure OpenAI 接口 +请参考：[#371](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/371) \ No newline at end of file diff --git a/docs/images/cover.png b/docs/images/cover.png new file mode 100644 index 000000000..20fbf6a86 Binary files /dev/null and b/docs/images/cover.png differ diff --git a/static/icon.svg b/docs/images/icon.svg similarity index 100% rename from static/icon.svg rename to docs/images/icon.svg diff --git a/docs/images/more.png b/docs/images/more.png new file mode 100644 index 000000000..dfdb3580d Binary files /dev/null and b/docs/images/more.png differ diff --git a/docs/images/settings.png b/docs/images/settings.png new file mode 100644 index 000000000..e1cdd07ee Binary files /dev/null and b/docs/images/settings.png differ diff --git a/package.json b/package.json index 18e227f1a..9fcb74e77 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "chatgpt-next-web", - "version": "1.1", + "version": "1.9.3", "private": false, "license": "Anti 996", "scripts": { @@ -12,6 +12,7 @@ "prepare": "husky install" }, "dependencies": { + "@hello-pangea/dnd": "^16.2.0", "@svgr/webpack": "^6.5.1", "@vercel/analytics": "^0.1.11", "emoji-picker-react": "^4.4.7", diff --git a/scripts/setup.sh b/scripts/setup.sh index 63a28bf09..b96533398 100644 --- a/scripts/setup.sh +++ b/scripts/setup.sh @@ -61,4 +61,5 @@ read -p "Enter CODE: " CODE read -p "Enter PORT: " PORT # Build and run the project using the environment variables -OPENAI_API_KEY=$OPENAI_API_KEY CODE=$CODE PORT=$PORT yarn build && OPENAI_API_KEY=$OPENAI_API_KEY CODE=$CODE PORT=$PORT yarn start +OPENAI_API_KEY=$OPENAI_API_KEY CODE=$CODE PORT=$PORT yarn build +OPENAI_API_KEY=$OPENAI_API_KEY CODE=$CODE PORT=$PORT yarn start diff --git a/static/cover.png b/static/cover.png deleted file mode 100644 index 0587bd29a..000000000 Binary files a/static/cover.png and /dev/null differ diff --git a/static/more.png b/static/more.png deleted file mode 100644 index 683a16f07..000000000 Binary files a/static/more.png and /dev/null differ diff --git a/static/settings.png b/static/settings.png deleted file mode 100644 index 22d841c31..000000000 Binary files a/static/settings.png and /dev/null differ diff --git a/yarn.lock b/yarn.lock index 9a937276c..88aa59823 100644 --- a/yarn.lock +++ b/yarn.lock @@ -954,7 +954,7 @@ resolved "https://registry.yarnpkg.com/@babel/regjsgen/-/regjsgen-0.8.0.tgz#f0ba69b075e1f05fb2825b7fad991e7adbb18310" integrity sha512-x/rqGMdzj+fWZvCOYForTghzbtqPDZ5gPwaoNGHdgDfF2QA/XZbCBp4Moo5scrkAMPhB7z26XM/AaHuIJdgauA== -"@babel/runtime@^7.20.7", "@babel/runtime@^7.8.4": +"@babel/runtime@^7.12.1", "@babel/runtime@^7.19.4", "@babel/runtime@^7.20.7", "@babel/runtime@^7.8.4", "@babel/runtime@^7.9.2": version "7.21.0" resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.21.0.tgz#5b55c9d394e5fcf304909a8b00c07dc217b56673" integrity sha512-xwII0//EObnq89Ji5AKYQaRYiW/nZ3llSv29d49IuxPhKbtJoLP+9QUUZ4nVragQVtaVGeZrpB+ZtG/Pdy/POw== @@ -1027,6 +1027,19 @@ resolved "https://registry.yarnpkg.com/@eslint/js/-/js-8.37.0.tgz#cf1b5fa24217fe007f6487a26d765274925efa7d" integrity sha512-x5vzdtOOGgFVDCUs81QRB2+liax8rFg3+7hqM+QhBG0/G3F1ZsoYl97UrqgHgQ9KKT7G6c4V+aTUCgu/n22v1A== +"@hello-pangea/dnd@^16.2.0": + version "16.2.0" + resolved "https://registry.npmmirror.com/@hello-pangea/dnd/-/dnd-16.2.0.tgz#58cbadeb56f8c7a381da696bb7aa3bfbb87876ec" + integrity sha512-inACvMcvvLr34CG0P6+G/3bprVKhwswxjcsFUSJ+fpOGjhvDj9caiA9X3clby0lgJ6/ILIJjyedHZYECB7GAgA== + dependencies: + "@babel/runtime" "^7.19.4" + css-box-model "^1.2.1" + memoize-one "^6.0.0" + raf-schd "^4.0.3" + react-redux "^8.0.4" + redux "^4.2.0" + use-memo-one "^1.1.3" + "@humanwhocodes/config-array@^0.11.8": version "0.11.8" resolved "https://registry.yarnpkg.com/@humanwhocodes/config-array/-/config-array-0.11.8.tgz#03595ac2075a4dc0f191cc2131de14fbd7d410b9" @@ -1333,6 +1346,14 @@ dependencies: "@types/unist" "*" +"@types/hoist-non-react-statics@^3.3.1": + version "3.3.1" + resolved "https://registry.npmmirror.com/@types/hoist-non-react-statics/-/hoist-non-react-statics-3.3.1.tgz#1124aafe5118cb591977aeb1ceaaed1070eb039f" + integrity sha512-iMIqiko6ooLrTh1joXodJK5X9xeEALT1kM5G3ZLhD3hszxBdIEd5C75U834D9mLcINgD4OyZf5uQXjkuYydWvA== + dependencies: + "@types/react" "*" + hoist-non-react-statics "^3.3.0" + "@types/json5@^0.0.29": version "0.0.29" resolved "https://registry.yarnpkg.com/@types/json5/-/json5-0.0.29.tgz#ee28707ae94e11d2b827bcbe5270bcea7f3e71ee" @@ -1408,6 +1429,11 @@ resolved "https://registry.yarnpkg.com/@types/unist/-/unist-2.0.6.tgz#250a7b16c3b91f672a24552ec64678eeb1d3a08d" integrity sha512-PBjIUxZHOuj0R15/xuwJYjFi+KZdNFrehocChv4g5hu6aFroHue8m0lBP0POdK2nKzbw0cgV1mws8+V/JAcEkQ== +"@types/use-sync-external-store@^0.0.3": + version "0.0.3" + resolved "https://registry.npmmirror.com/@types/use-sync-external-store/-/use-sync-external-store-0.0.3.tgz#b6725d5f4af24ace33b36fafd295136e75509f43" + integrity sha512-EwmlvuaxPNej9+T4v5AuBPJa2x2UOJVdjCtDHgcDqitUeOtjnJKJ+apYjVcAoBEMjKW1VVFGZLUb5+qqa09XFA== + "@typescript-eslint/parser@^5.42.0": version "5.57.0" resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-5.57.0.tgz#f675bf2cd1a838949fd0de5683834417b757e4fa" @@ -1912,6 +1938,13 @@ cross-spawn@^7.0.1, cross-spawn@^7.0.2, cross-spawn@^7.0.3: shebang-command "^2.0.0" which "^2.0.1" +css-box-model@^1.2.1: + version "1.2.1" + resolved "https://registry.npmmirror.com/css-box-model/-/css-box-model-1.2.1.tgz#59951d3b81fd6b2074a62d49444415b0d2b4d7c1" + integrity sha512-a7Vr4Q/kd/aw96bnJG332W9V9LkJO69JRcaCYDUqjp6/z0w6VcZjgAcTbgFxEPfBgdnAwlh3iwu+hLopa+flJw== + dependencies: + tiny-invariant "^1.0.6" + css-select@^4.1.3: version "4.3.0" resolved "https://registry.yarnpkg.com/css-select/-/css-select-4.3.0.tgz#db7129b2846662fd8628cfc496abb2b59e41529b" @@ -2885,6 +2918,13 @@ highlight.js@~11.7.0: resolved "https://registry.yarnpkg.com/highlight.js/-/highlight.js-11.7.0.tgz#3ff0165bc843f8c9bce1fd89e2fda9143d24b11e" integrity sha512-1rRqesRFhMO/PRF+G86evnyJkCgaZFOI+Z6kdj15TA18funfoqJXvgPCLSf0SWq3SRfg1j3HlDs8o4s3EGq1oQ== +hoist-non-react-statics@^3.3.0, hoist-non-react-statics@^3.3.2: + version "3.3.2" + resolved "https://registry.npmmirror.com/hoist-non-react-statics/-/hoist-non-react-statics-3.3.2.tgz#ece0acaf71d62c2969c2ec59feff42a4b1a85b45" + integrity sha512-/gGivxi8JPKWNm/W0jSmzcMPpfpPLc3dY/6GxhX2hQ9iGj3aDfklV4ET7NjKpSinLpJ5vafa9iiGIEZg10SfBw== + dependencies: + react-is "^16.7.0" + human-signals@^4.3.0: version "4.3.1" resolved "https://registry.yarnpkg.com/human-signals/-/human-signals-4.3.1.tgz#ab7f811e851fca97ffbd2c1fe9a958964de321b2" @@ -3527,6 +3567,11 @@ mdn-data@2.0.14: resolved "https://registry.yarnpkg.com/mdn-data/-/mdn-data-2.0.14.tgz#7113fc4281917d63ce29b43446f701e68c25ba50" integrity sha512-dn6wd0uw5GsdswPFfsgMp5NSB0/aDe6fK94YJV/AJDYXL6HVLWBsxeq7js7Ad+mU2K9LAlwpk6kN2D5mwCPVow== +memoize-one@^6.0.0: + version "6.0.0" + resolved "https://registry.npmmirror.com/memoize-one/-/memoize-one-6.0.0.tgz#b2591b871ed82948aee4727dc6abceeeac8c1045" + integrity sha512-rkpe71W0N0c0Xz6QD0eJETuWAJGnJ9afsl1srmwPrI+yBCkge5EycXXbYRyvL29zZVUWQCY7InPRCv3GDXuZNw== + merge-stream@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/merge-stream/-/merge-stream-2.0.0.tgz#52823629a14dd00c9770fb6ad47dc6310f2c1f60" @@ -4211,6 +4256,11 @@ queue-microtask@^1.2.2: resolved "https://registry.yarnpkg.com/queue-microtask/-/queue-microtask-1.2.3.tgz#4929228bbc724dfac43e0efb058caf7b6cfb6243" integrity sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A== +raf-schd@^4.0.3: + version "4.0.3" + resolved "https://registry.npmmirror.com/raf-schd/-/raf-schd-4.0.3.tgz#5d6c34ef46f8b2a0e880a8fcdb743efc5bfdbc1a" + integrity sha512-tQkJl2GRWh83ui2DiPTJz9wEiMN20syf+5oKfB03yYP7ioZcJwsIK8FjrtLwH1m7C7e+Tt2yYBlrOpdT+dyeIQ== + react-dom@^18.2.0: version "18.2.0" resolved "https://registry.yarnpkg.com/react-dom/-/react-dom-18.2.0.tgz#22aaf38708db2674ed9ada224ca4aa708d821e3d" @@ -4219,7 +4269,7 @@ react-dom@^18.2.0: loose-envify "^1.1.0" scheduler "^0.23.0" -react-is@^16.13.1: +react-is@^16.13.1, react-is@^16.7.0: version "16.13.1" resolved "https://registry.yarnpkg.com/react-is/-/react-is-16.13.1.tgz#789729a4dc36de2999dc156dd6c1d9c18cea56a4" integrity sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ== @@ -4250,6 +4300,18 @@ react-markdown@^8.0.5: unist-util-visit "^4.0.0" vfile "^5.0.0" +react-redux@^8.0.4: + version "8.0.5" + resolved "https://registry.npmmirror.com/react-redux/-/react-redux-8.0.5.tgz#e5fb8331993a019b8aaf2e167a93d10af469c7bd" + integrity sha512-Q2f6fCKxPFpkXt1qNRZdEDLlScsDWyrgSj0mliK59qU6W5gvBiKkdMEG2lJzhd1rCctf0hb6EtePPLZ2e0m1uw== + dependencies: + "@babel/runtime" "^7.12.1" + "@types/hoist-non-react-statics" "^3.3.1" + "@types/use-sync-external-store" "^0.0.3" + hoist-non-react-statics "^3.3.2" + react-is "^18.0.0" + use-sync-external-store "^1.0.0" + react@^18.2.0: version "18.2.0" resolved "https://registry.yarnpkg.com/react/-/react-18.2.0.tgz#555bd98592883255fa00de14f1151a917b5d77d5" @@ -4264,6 +4326,13 @@ readdirp@~3.6.0: dependencies: picomatch "^2.2.1" +redux@^4.2.0: + version "4.2.1" + resolved "https://registry.npmmirror.com/redux/-/redux-4.2.1.tgz#c08f4306826c49b5e9dc901dee0452ea8fce6197" + integrity sha512-LAUYz4lc+Do8/g7aeRa8JkyDErK6ekstQaqWQrNRW//MY1TvCEpMtpTWvlQ+FPbWCx+Xixu/6SHt5N0HR+SB4w== + dependencies: + "@babel/runtime" "^7.9.2" + regenerate-unicode-properties@^10.1.0: version "10.1.0" resolved "https://registry.yarnpkg.com/regenerate-unicode-properties/-/regenerate-unicode-properties-10.1.0.tgz#7c3192cab6dd24e21cb4461e5ddd7dd24fa8374c" @@ -4774,6 +4843,11 @@ tiny-glob@^0.2.9: globalyzer "0.1.0" globrex "^0.1.2" +tiny-invariant@^1.0.6: + version "1.3.1" + resolved "https://registry.npmmirror.com/tiny-invariant/-/tiny-invariant-1.3.1.tgz#8560808c916ef02ecfd55e66090df23a4b7aa642" + integrity sha512-AD5ih2NlSssTCwsMznbvwMZpJ1cbhkGd2uueNxzv2jDlEeZdU04JQfRnggJQ8DrcVBGjAsCKwFBbDlVNtEMlzw== + to-fast-properties@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/to-fast-properties/-/to-fast-properties-2.0.0.tgz#dc5e698cbd079265bc73e0377681a4e4e83f616e" @@ -4979,7 +5053,12 @@ use-debounce@^9.0.3: resolved "https://registry.yarnpkg.com/use-debounce/-/use-debounce-9.0.3.tgz#bac660c19ab7b38662e08608fee23c7ad303f532" integrity sha512-FhtlbDtDXILJV7Lix5OZj5yX/fW1tzq+VrvK1fnT2bUrPOGruU9Rw8NCEn+UI9wopfERBEZAOQ8lfeCJPllgnw== -use-sync-external-store@1.2.0: +use-memo-one@^1.1.3: + version "1.1.3" + resolved "https://registry.npmmirror.com/use-memo-one/-/use-memo-one-1.1.3.tgz#2fd2e43a2169eabc7496960ace8c79efef975e99" + integrity sha512-g66/K7ZQGYrI6dy8GLpVcMsBp4s17xNkYJVSMvTEevGy3nDxHOfE6z8BVE22+5G5x7t3+bhzrlTDB7ObrEE0cQ== + +use-sync-external-store@1.2.0, use-sync-external-store@^1.0.0: version "1.2.0" resolved "https://registry.yarnpkg.com/use-sync-external-store/-/use-sync-external-store-1.2.0.tgz#7dbefd6ef3fe4e767a0cf5d7287aacfb5846928a" integrity sha512-eEgnFxGQ1Ife9bzYs6VLi8/4X6CObHMw9Qr9tPY43iKwsPw8xE8+EFsf/2cFZ5S3esXgpWgtSCtLNS41F+sKPA==