158 lines
5.6 KiB
Markdown
158 lines
5.6 KiB
Markdown
<div align="center">
|
||
<img src="./static/icon.svg" alt="预览"/>
|
||
|
||
<h1 align="center">ChatGPT Next Web</h1>
|
||
|
||
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) / [Donate by WechatPay](https://user-images.githubusercontent.com/16968934/227772541-5bcd52d8-61b7-488c-a203-0330d8006e2b.jpg) / [Donate](#捐赠-donate-usdt)
|
||
|
||
[](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)
|
||
|
||
[](https://gitpod.io/#https://github.com/Yidadaa/ChatGPT-Next-Web)
|
||
|
||
|
||
|
||
</div>
|
||
|
||
English | [简体中文](./README-zh_CN.md)
|
||
|
||
## Features
|
||
|
||
- **Deploy for free with one-click** on Vercel in under 1 minute
|
||
- Responsive design, and dark mode
|
||
- Fast first screen loading speed (~85kb)
|
||
- 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
|
||
|
||
## Roadmap
|
||
|
||
- 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
|
||
- 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
|
||
|
||
- User login, accounts, cloud sync
|
||
- UI text customize
|
||
|
||
## Get Started
|
||
|
||
1. Get [OpenAI API Key](https://platform.openai.com/account/api-keys)
|
||
2. Click [](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)
|
||
3. Enjoy :)
|
||
4. [Custom Domain](https://vercel.com/docs/concepts/projects/domains/add-a-domain) (Optional)
|
||
|
||
## Keep Updated
|
||
|
||
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.
|
||
|
||
We recommend that you follow the steps below to re-deploy:
|
||
|
||
- Delete the original repo;
|
||
- Fork this project;
|
||
- Go to the Vercel dashboard, delete the original project, then create a new project and select the project you just forked to redeploy;
|
||
- Please manually add an environment variable named `OPENAI_API_KEY` and enter your API key as the value during the redeploy process.
|
||
|
||
This project will be continuously maintained. If you want to keep the code repository up to date, you can check out the [Github documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork) to learn how to synchronize a forked project with upstream code. It is recommended to perform synchronization operations regularly.
|
||
|
||
You can star or watch this project or follow author to get release notifictions in time.
|
||
|
||
## Password
|
||
|
||
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:
|
||
|
||
```
|
||
code1,code2,code3
|
||
```
|
||
|
||
After adding or modifying this environment variable, please redeploy the project for the changes to take effect.
|
||
|
||
## Environment Variables
|
||
|
||
### `OPENAI_API_KEY` (required)
|
||
|
||
Your openai api key.
|
||
|
||
### `CODE` (optional)
|
||
|
||
Access passsword, separated by comma.
|
||
|
||
### `BASE_URL` (optional)
|
||
|
||
> Default: `api.openai.com`
|
||
|
||
Override openai api request base url.
|
||
|
||
### `PROTOCOL` (optional)
|
||
|
||
> Default: `https`
|
||
|
||
> Values: `http` | `https`
|
||
|
||
Override openai api request protocol.
|
||
|
||
## Development
|
||
|
||
Click the button below to start secondary development:
|
||
|
||
[](https://gitpod.io/#https://github.com/Yidadaa/ChatGPT-Next-Web)
|
||
|
||
Before starting development, you must create a new `.env.local` file at project root, and place your api key into it:
|
||
|
||
```
|
||
OPENAI_API_KEY=<your api key here>
|
||
```
|
||
|
||
### Local Development
|
||
|
||
1. install nodejs and yarn,to obtain additional information, you can ask ChatGPT for further details；
|
||
2. run `yarn install && yarn dev`
|
||
|
||
### Local Deployment
|
||
|
||
```shell
|
||
bash <(curl -s https://raw.githubusercontent.com/Yidadaa/ChatGPT-Next-Web/main/scripts/setup.sh)
|
||
```
|
||
|
||
### Docker Deployment
|
||
|
||
```shell
|
||
docker pull yidadaa/chatgpt-next-web
|
||
|
||
docker run -d -p 3000:3000 -e OPENAI_API_KEY="" -e CODE="" yidadaa/chatgpt-next-web
|
||
```
|
||
|
||
## Screenshots
|
||
|
||
|
||
|
||
|
||
|
||
## Donate USDT
|
||
|
||
> BNB Smart Chain (BEP 20)
|
||
|
||
```
|
||
0x67cD02c7EB62641De576a1fA3EdB32eA0c3ffD89
|
||
```
|
||
|
||
## Special Thanks
|
||
|
||
### Sponsor
|
||
|
||
[@mushan0x0](https://github.com/mushan0x0)
|
||
[@ClarenceDan](https://github.com/ClarenceDan)
|
||
[@zhangjia](https://github.com/zhangjia)
|
||
[@hoochanlon](https://github.com/hoochanlon)
|
||
|
||
### Contributor
|
||
|
||
[Contributors](https://github.com/Yidadaa/ChatGPT-Next-Web/graphs/contributors)
|
||
|
||
## LICENSE
|
||
|
||
[Anti 996 License](https://github.com/kattgu7/Anti-996-License/blob/master/LICENSE_CN_EN)
|