chore: doc

This commit is contained in:
ChenZhoYu 2024-03-11 12:00:53 +08:00
parent c520580cda
commit 6432efeb35
2 changed files with 40 additions and 30 deletions

View File

@ -8,35 +8,36 @@
![cover2](./docs/c2.png) ![cover2](./docs/c2.png)
- [ChatGPT Web](#chatgpt-web) - [ChatGPT Web](#chatgpt-web)
- [Introduction](#introduction) - [Introduction](#introduction)
- [To-Do List](#to-do-list) - [Roadmap](#roadmap)
- [Prerequisites](#prerequisites) - [Prerequisites](#prerequisites)
- [Node](#node) - [Node](#node)
- [PNPM](#pnpm) - [PNPM](#pnpm)
- [Fill in Keys](#fill-in-keys) - [Filling in the Key](#filling-in-the-key)
- [Install Dependencies](#install-dependencies) - [Install Dependencies](#install-dependencies)
- [Backend](#backend) - [Backend](#backend)
- [Frontend](#frontend) - [Frontend](#frontend)
- [Run in Test Environment](#run-in-test-environment) - [Run in Test Environment](#run-in-test-environment)
- [Backend Service](#backend-service) - [Backend Service](#backend-service)
- [Frontend Webpage](#frontend-webpage) - [Frontend Webpage](#frontend-webpage)
- [Environment Variables](#environment-variables) - [Environment Variables](#environment-variables)
- [Packaging](#packaging) - [Packaging](#packaging)
- [Use Docker](#use-docker) - [Use Docker](#use-docker)
- [Docker Parameter Examples](#docker-parameter-examples) - [Docker Parameter Examples](#docker-parameter-examples)
- [Docker Build & Run](#docker-build--run) - [Docker build \& Run](#docker-build--run)
- [Docker Compose](#docker-compose) - [Docker compose](#docker-compose)
- [Prevent Crawlers](#prevent-crawlers) - [Prevent Crawlers](#prevent-crawlers)
- [Deploy with Railway](#deploy-with-railway) - [Deploy with Railway](#deploy-with-railway)
- [Railway Environment Variables](#railway-environment-variables) - [Railway Environment Variables](#railway-environment-variables)
- [Deploy with Sealos](#deploy-with-sealos) - [Deploy with Sealos](#deploy-with-sealos)
- [Package Manually](#package-manually) - [Package Manually](#package-manually)
- [Backend Service](#backend-service-1) - [Backend Service](#backend-service-1)
- [Frontend Webpage](#frontend-webpage-1) - [Frontend Webpage](#frontend-webpage-1)
- [FAQ](#faq) - [FAQ](#faq)
- [Contributing](#contributing) - [Contributing](#contributing)
- [Sponsors](#sponsors) - [Acknowledgements](#acknowledgements)
- [License](#license) - [Sponsors](#sponsors)
- [License](#license)
## Introduction ## Introduction
Supports dual models and provides two unofficial `ChatGPT API` methods Supports dual models and provides two unofficial `ChatGPT API` methods
@ -340,6 +341,10 @@ Thanks to everyone who has contributed!
<img src="https://contrib.rocks/image?repo=Chanzhaoyu/chatgpt-web" /> <img src="https://contrib.rocks/image?repo=Chanzhaoyu/chatgpt-web" />
</a> </a>
## Acknowledgements
Thanks to [JetBrains](https://www.jetbrains.com/) SoftWare for providing free Open Source license for this project.
## Sponsors ## Sponsors
If you find this project helpful and can afford it, you can give me a little support. Anyway, thanks for your support~ If you find this project helpful and can afford it, you can give me a little support. Anyway, thanks for your support~
@ -356,4 +361,4 @@ If you find this project helpful and can afford it, you can give me a little sup
</div> </div>
## License ## License
MIT © [ChenZhaoYu] MIT © [ChenZhaoYu]

View File

@ -35,6 +35,7 @@
- [前端网页](#前端网页-1) - [前端网页](#前端网页-1)
- [常见问题](#常见问题) - [常见问题](#常见问题)
- [参与贡献](#参与贡献) - [参与贡献](#参与贡献)
- [致谢](#致谢)
- [赞助](#赞助) - [赞助](#赞助)
- [License](#license) - [License](#license)
## 介绍 ## 介绍
@ -343,6 +344,10 @@ A: 一种可能原因是经过 Nginx 反向代理,开启了 buffer则 Nginx
<img src="https://contrib.rocks/image?repo=Chanzhaoyu/chatgpt-web" /> <img src="https://contrib.rocks/image?repo=Chanzhaoyu/chatgpt-web" />
</a> </a>
## 致谢
感谢 [JetBrains](https://www.jetbrains.com/) 为这个项目提供免费开源许可的软件。
## 赞助 ## 赞助
如果你觉得这个项目对你有帮助,并且情况允许的话,可以给我一点点支持,总之非常感谢支持~ 如果你觉得这个项目对你有帮助,并且情况允许的话,可以给我一点点支持,总之非常感谢支持~