LibreChat/README.md

83 lines
4.7 KiB
Markdown
Raw Normal View History

2023-02-14 16:33:22 -05:00
# ChatGPT Clone #
2023-02-14 19:03:48 -05:00
![chatgpt-clone demo](./demo.gif)
2023-02-14 16:33:22 -05:00
## Wrap all conversational AIs under one roof. ##
2023-02-14 18:31:29 -05:00
Conversational/Utility AIs are the future and OpenAI revolutionized this movement with ChatGPT. While numerous methods exist to integrate conversational AIs, this app commemorates the original styling of ChatGPT, with the ability to integrate any current/future conversational AI models through user-provided APIs, while also having in mind improved client features, such as conversation search, and prompt templates. This project was also built with the anticipation of the official ChatGPT API from OpenAI, though it uses unofficial packages. Through this clone, you can avoid subscription-based models in favor of either free or pay-per-call APIs. I will most likely not deploy this app, as it's mainly a learning experience, but feel free to clone or fork to create your own custom wrapper.
2023-02-14 16:33:22 -05:00
2023-02-14 19:38:28 -05:00
## Origin ##
This project was originally created as a Minimum Viable Product (or MVP) for the [@HackReactor](https://github.com/hackreactor/) Bootcamp. It was built with OpenAI response streaming and most of the UI completed in under 20 hours. If you're curious what it looked like 20 hours in, you can find the [original MVP project here](https://github.com/danny-avila/rpp2210-mvp). This was created without using any boilerplates or templates, including create-react-app and other toolchains. The purpose of the exercise was to learn setting up a full stack project from scratch. Please feel free to give feedback, suggestions, or fork the project for your own use.
2023-02-14 18:31:29 -05:00
## Updates
<details open>
2023-02-21 21:41:30 -05:00
<summary><strong>2023-02-21</strong></summary>
BingAI is integrated (although sadly limited by Microsoft with the 5 msg/convo limit, 50 msgs/day). I will need to handle the case when Bing refuses to give more answers on top of the other styling features I have in mind. Official ChatGPT use is back with the new BrowserClient. Brainstorming how to handle the UI when the Ai model changes, since conversations can't be persisted between them (or perhaps build a way to achieve this at some level).
</details>
<details >
2023-02-15 00:06:10 -05:00
<summary><strong>2023-02-15</strong></summary>
Just got access to Bing AI so I'll be focusing on integrating that through waylaidwanderer's 'experimental' BingAIClient.
</details>
2023-02-21 21:41:30 -05:00
<details>
2023-02-14 18:31:29 -05:00
<summary><strong>2023-02-14</strong></summary>
Official ChatGPT use is no longer possible though I recently used it with waylaidwanderer's [reverse proxy method](https://github.com/waylaidwanderer/node-chatgpt-api/blob/main/README.md#using-a-reverse-proxy), and before that, through leaked models he also discovered.
Currently, this project is only functional with the `text-davinci-003` model.
</details>
2023-02-14 16:33:22 -05:00
## Roadmap
> **Warning**
2023-02-15 00:06:10 -05:00
> This is a work in progress. I'm building this in public. You can follow the progress here or on my [Linkedin](www.linkedin.com/in/danny-avila).
2023-02-14 16:33:22 -05:00
> Here are my planned/recently finished features.
2023-02-14 19:46:24 -05:00
- [x] Rename, delete conversations
- [x] Persistent conversation
- [x] UI Error handling
2023-02-14 16:33:22 -05:00
- [x] AI Model Selection
2023-02-21 21:41:30 -05:00
- [x] Bing AI integration
- [ ] Remember last selected model
- [ ] AI model change handling (whether to pseudo-persist convos or start new convos within existing convo)
2023-02-14 18:40:00 -05:00
- [ ] Highlight.js for code blocks
2023-02-21 21:41:30 -05:00
- [ ] Server convo pagination (limit fetch and load more with 'show more' button)
2023-02-14 18:31:29 -05:00
- [ ] Prompt Templates
2023-02-21 21:41:30 -05:00
- [ ] Bing AI Styling (for suggested responses, convo end, etc.)
2023-02-14 16:33:22 -05:00
- [ ] Conversation/Prompt Search
2023-02-21 21:41:30 -05:00
- [ ] Refactor/clean up code
2023-02-14 18:40:00 -05:00
- [ ] Config file for easy startup
2023-02-14 19:03:48 -05:00
- [ ] Mobile styling (half-finished)
2023-02-14 18:40:00 -05:00
- [ ] Semantic Search Option (requires more tokens)
2023-02-14 16:33:22 -05:00
### Features
- Response streaming identical to ChatGPT
2023-02-14 18:31:29 -05:00
- UI from original ChatGPT, including Dark mode
2023-02-14 16:33:22 -05:00
- AI model selection
2023-02-14 18:31:29 -05:00
2023-02-21 21:41:30 -05:00
### Tech Stack
2023-02-14 18:31:29 -05:00
- Utilizes [node-chatgpt-api](https://github.com/waylaidwanderer/node-chatgpt-api)
2023-02-14 18:31:29 -05:00
- Response streaming identical to ChatGPT through server-sent events
2023-02-14 19:11:47 -05:00
- Use of Tailwind CSS (like the official site) and [shadcn/ui](https://github.com/shadcn/ui) components
- useSWR, Redux Toolkit, Express, MongoDB, [Keyv](https://www.npmjs.com/package/keyv)
2023-02-14 16:33:22 -05:00
2023-02-14 18:40:00 -05:00
## Use Cases ##
2023-02-14 16:33:22 -05:00
![use case example](./use_case.png "GPT is down! Plus is too expensive!")
2023-02-14 18:40:00 -05:00
- ChatGPT is down ( and don't want to pay for ChatGPT Plus).
- ChatGPT/Google Bard/Bing AI conversations are lost in space or
2023-02-14 16:33:22 -05:00
cannot be searched past a certain timeframe.
2023-02-21 21:41:30 -05:00
- Quick one stop shop for all conversational AIs, with the added bonus of searching
2023-02-14 16:33:22 -05:00
<!-- ## Solution ##
2023-02-14 16:33:22 -05:00
Serves and searches all conversations reliably. All AI convos under one house.
Pay per call and not per month (cents compared to dollars). -->
2023-02-14 16:33:22 -05:00
2023-02-14 18:31:29 -05:00
## How to Get Started ##
> **Warning**
2023-02-14 18:34:46 -05:00
> Working on easy startup/config code. Still in development.
2023-02-14 16:33:22 -05:00
<!-- ## License
Licensed under the [insert license here](). -->