Skip to content

Commit

Permalink
chore: doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Chanzhaoyu committed Mar 11, 2024
1 parent c520580 commit 6432efe
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 30 deletions.
65 changes: 35 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,35 +8,36 @@
![cover2](./docs/c2.png)

- [ChatGPT Web](#chatgpt-web)
- [Introduction](#introduction)
- [To-Do List](#to-do-list)
- [Prerequisites](#prerequisites)
- [Node](#node)
- [PNPM](#pnpm)
- [Fill in Keys](#fill-in-keys)
- [Install Dependencies](#install-dependencies)
- [Backend](#backend)
- [Frontend](#frontend)
- [Run in Test Environment](#run-in-test-environment)
- [Backend Service](#backend-service)
- [Frontend Webpage](#frontend-webpage)
- [Environment Variables](#environment-variables)
- [Packaging](#packaging)
- [Use Docker](#use-docker)
- [Docker Parameter Examples](#docker-parameter-examples)
- [Docker Build & Run](#docker-build--run)
- [Docker Compose](#docker-compose)
- [Prevent Crawlers](#prevent-crawlers)
- [Deploy with Railway](#deploy-with-railway)
- [Railway Environment Variables](#railway-environment-variables)
- [Deploy with Sealos](#deploy-with-sealos)
- [Package Manually](#package-manually)
- [Backend Service](#backend-service-1)
- [Frontend Webpage](#frontend-webpage-1)
- [FAQ](#faq)
- [Contributing](#contributing)
- [Sponsors](#sponsors)
- [License](#license)
- [Introduction](#introduction)
- [Roadmap](#roadmap)
- [Prerequisites](#prerequisites)
- [Node](#node)
- [PNPM](#pnpm)
- [Filling in the Key](#filling-in-the-key)
- [Install Dependencies](#install-dependencies)
- [Backend](#backend)
- [Frontend](#frontend)
- [Run in Test Environment](#run-in-test-environment)
- [Backend Service](#backend-service)
- [Frontend Webpage](#frontend-webpage)
- [Environment Variables](#environment-variables)
- [Packaging](#packaging)
- [Use Docker](#use-docker)
- [Docker Parameter Examples](#docker-parameter-examples)
- [Docker build \& Run](#docker-build--run)
- [Docker compose](#docker-compose)
- [Prevent Crawlers](#prevent-crawlers)
- [Deploy with Railway](#deploy-with-railway)
- [Railway Environment Variables](#railway-environment-variables)
- [Deploy with Sealos](#deploy-with-sealos)
- [Package Manually](#package-manually)
- [Backend Service](#backend-service-1)
- [Frontend Webpage](#frontend-webpage-1)
- [FAQ](#faq)
- [Contributing](#contributing)
- [Acknowledgements](#acknowledgements)
- [Sponsors](#sponsors)
- [License](#license)
## Introduction

Supports dual models and provides two unofficial `ChatGPT API` methods
Expand Down Expand Up @@ -340,6 +341,10 @@ Thanks to everyone who has contributed!
<img src="https://contrib.rocks/image?repo=Chanzhaoyu/chatgpt-web" />
</a>

## Acknowledgements

Thanks to [JetBrains](https://www.jetbrains.com/) SoftWare for providing free Open Source license for this project.

## Sponsors

If you find this project helpful and can afford it, you can give me a little support. Anyway, thanks for your support~
Expand All @@ -356,4 +361,4 @@ If you find this project helpful and can afford it, you can give me a little sup
</div>

## License
MIT © [ChenZhaoYu]
MIT © [ChenZhaoYu]
5 changes: 5 additions & 0 deletions README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
- [前端网页](#前端网页-1)
- [常见问题](#常见问题)
- [参与贡献](#参与贡献)
- [致谢](#致谢)
- [赞助](#赞助)
- [License](#license)
## 介绍
Expand Down Expand Up @@ -343,6 +344,10 @@ A: 一种可能原因是经过 Nginx 反向代理,开启了 buffer,则 Nginx
<img src="https://contrib.rocks/image?repo=Chanzhaoyu/chatgpt-web" />
</a>

## 致谢

感谢 [JetBrains](https://www.jetbrains.com/) 为这个项目提供免费开源许可的软件。

## 赞助

如果你觉得这个项目对你有帮助,并且情况允许的话,可以给我一点点支持,总之非常感谢支持~
Expand Down

0 comments on commit 6432efe

Please sign in to comment.