Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Features/fix modify stream #490

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
140 changes: 1 addition & 139 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,9 @@
<h1 align="center"><b>Better ChatGPT</b></h1>

<p align="center">
English Version |
<a href="README-zh_CN.md">
简体中文版
</a>
</p>
<h1 align="center"><b>Quantum ChatGPT</b></h1>

<p align="center">
<a href="https://bettergpt.chat" target="_blank"><img src="public/apple-touch-icon.png" alt="Better ChatGPT" width="100" /></a>
</p>

<h4 align="center"><b>Free, Powerful, Limitless, Intelligent, Engaging</b></h4>

<p align="center">
<a href="https://github.com/ztjhz/BetterChatGPT/blob/main/LICENSE" target="_blank">
<img src="https://img.shields.io/github/license/ztjhz/BetterChatGPT?style=flat-square" alt="licence" />
</a>
<a href="https://github.com/ztjhz/BetterChatGPT/fork" target="_blank">
<img src="https://img.shields.io/github/forks/ztjhz/BetterChatGPT?style=flat-square" alt="forks"/>
</a>
<a href="https://github.com/ztjhz/BetterChatGPT/stargazers" target="_blank">
<img src="https://img.shields.io/github/stars/ztjhz/BetterChatGPT?style=flat-square" alt="stars"/>
</a>
<a href="https://github.com/ztjhz/BetterChatGPT/issues" target="_blank">
<img src="https://img.shields.io/github/issues/ztjhz/BetterChatGPT?style=flat-square" alt="issues"/>
</a>
<a href="https://github.com/ztjhz/BetterChatGPT/pulls" target="_blank">
<img src="https://img.shields.io/github/issues-pr/ztjhz/BetterChatGPT?style=flat-square" alt="pull-requests"/>
</a>
<a href="https://twitter.com/intent/tweet?text=👋%20Check%20this%20amazing%20repo%20https://github.com/ztjhz/BetterChatGPT,%20created%20by%20@nikushii_"><img src="https://img.shields.io/twitter/url?label=Share%20on%20Twitter&style=social&url=https%3A%2F%2Fgithub.com%2Fztjhz%2FBetterChatGPT"></a>
</p>

<p align="center">
<a href="https://bettergpt.chat">Enter Website</a>
·
<a href="https://github.com/ztjhz/BetterChatGPT/issues/new/choose">Report Bug</a>
·
<a href="https://github.com/ztjhz/BetterChatGPT/issues/new/choose">Request Feature</a>
</p>
<p align="center"><i>Did you enjoy using Better ChatGPT? Give it some love with a star! 🌟</i></p>

## 👋🏻 Introducing Better ChatGPT

<p align="center">
Expand Down Expand Up @@ -72,106 +35,5 @@ Better ChatGPT comes with a bundle of amazing features! Here are some of them:
- Save chat automatically to local storage
- Import / Export chat
- Download chat (markdown / image / json)
- Sync to Google Drive
- Azure OpenAI endpoint support
- Multiple language support (i18n)

# 🛠️ Usage

To get started, simply visit our website at <https://bettergpt.chat/>. There are 3 ways for you to start using Better ChatGPT.

1. Enter into the API menu your OpenAI API Key obtained from [OpenAI API Keys](https://platform.openai.com/account/api-keys).
2. Utilise the api endpoint proxy provided by [ayaka14732/ChatGPTAPIFree](https://github.com/ayaka14732/ChatGPTAPIFree) (if you are in a region with no access to ChatGPT)
3. Host your own API endpoint by following the instructions provided here: <https://github.com/ayaka14732/ChatGPTAPIFree>. Subsequently, enter the API endpoint into the API menu.

## Desktop App

Download the desktop app [here](https://github.com/ztjhz/BetterChatGPT/releases)

| OS | Download |
| ------- | --------- |
| Windows | .exe |
| MacOS | .dmg |
| Linux | .AppImage |

### Features:

- Unlimited local storage
- Runs locally (access Better ChatGPT even if the website is not accessible)

# 🛫 Host your own Instance

If you'd like to run your own instance of Better ChatGPT, you can easily do so by following these steps:

## Vercel

One click deploy with Vercel

[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fztjhz%2FBetterChatGPT)

## GitHub Pages

### Steps

1. Create a GitHub account (if you don't have one already)
1. Star this [repository](https://github.com/ztjhz/BetterChatGPT) ⭐️
1. Fork this [repository](https://github.com/ztjhz/BetterChatGPT)
1. In your forked repository, navigate to the `Settings` tab
![image](https://user-images.githubusercontent.com/59118459/223753577-9b6f8266-26e8-471b-8f45-a1a02fbab232.png)
1. In the left sidebar, click on `Pages` and in the right section, select `GitHub Actions` for `source`.
![image](https://user-images.githubusercontent.com/59118459/227568881-d8fb7baa-f890-4dee-8fc2-b6b429ba2098.png)
1. Now, click on `Actions`
![image](https://user-images.githubusercontent.com/59118459/223751928-cf2b91b9-4663-4a36-97de-5eb751b32c7e.png)
1. In the left sidebar, click on `Deploy to GitHub Pages`
![image](https://user-images.githubusercontent.com/59118459/223752459-183ec23f-72f5-436e-a088-e3386492b8cb.png)
1. Above the list of workflow runs, select `Run workflow`.
![image](https://user-images.githubusercontent.com/59118459/223753340-1270e038-d213-4d6f-938c-66a30dad7c88.png)
1. Navigate back to the `Settings` tab
![image](https://user-images.githubusercontent.com/59118459/223753577-9b6f8266-26e8-471b-8f45-a1a02fbab232.png)
1. In the left sidebar, click on `Pages` and in the right section. Then at the top section, you can see that "Your site is live at `XXX`".
![image](https://user-images.githubusercontent.com/59118459/227568881-d8fb7baa-f890-4dee-8fc2-b6b429ba2098.png)

### Running it locally

1. Ensure that you have the following installed:

- [node.js](https://nodejs.org/en/)
- [yarn](https://yarnpkg.com/) or [npm](https://www.npmjs.com/)

2. Clone this [repository](https://github.com/ztjhz/BetterChatGPT) by running `git clone https://github.com/ztjhz/BetterChatGPT.git`
3. Navigate into the directory by running `cd BetterChatGPT`
4. Run `yarn` or `npm install`, depending on whether you have yarn or npm installed.
5. Launch the app by running `yarn dev` or `npm run dev`

# ⭐️ Star History

[![Star History Chart](https://api.star-history.com/svg?repos=ztjhz/BetterChatGPT&type=Date)](https://github.com/ztjhz/BetterChatGPT/stargazers)

<h3 align="center">
A ⭐️ to <b>Better ChatGPT</b> is to make it shine brighter and benefit more people.
</h3>

# ❤️ Contributors

Thanks to all the contributors!

<a href="https://github.com/ztjhz/BetterChatGPT/graphs/contributors">
<img src="https://contrib.rocks/image?repo=ztjhz/BetterChatGPT" />
</a>

# 🙏 Support

At Better ChatGPT, we strive to provide you with useful and amazing features around the clock. And just like any project, your support and motivation will be instrumental in helping us keep moving forward!

If you have enjoyed using our app, we kindly ask you to give this project a ⭐️. Your endorsement means a lot to us and encourages us to work harder towards delivering the best possible experience.

If you would like to support the team, consider sponsoring us through one of the methods below. Every contribution, no matter how small, helps us to maintain and improve our service.

| Payment Method | Link |
| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| GitHub | [![GitHub Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/ztjhz) |
| KoFi | [![support](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/betterchatgpt) |
| Alipay (Ayaka) | <img src="https://ayaka14732.github.io/sponsor/alipay.jpg" width=150 /> |
| Wechat (Ayaka) | <img src="https://ayaka14732.github.io/sponsor/wechat.png" width=150 /> |

Thank you for being a part of our community, and we look forward to serving you better in the future.
Loading