refactor: update references from chatgpt-clone to LibreChat (#541)

* refactor: update references from chatgpt-clone to LibreChat

* refactor: update references from chatgpt-clone to LibreChat
This commit is contained in:
Fuegovic 2023-06-22 20:12:25 -04:00 committed by GitHub
parent 3d40dce76a
commit 731304f96a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 34 additions and 34 deletions

View file

@ -116,13 +116,13 @@ CREDS_IV=e2341419ec3dd3d19b13a1a87fafcbfb
# AI-Assisted Google Search # AI-Assisted Google Search
# This bot supports searching google for answers to your questions with assistance from GPT! # This bot supports searching google for answers to your questions with assistance from GPT!
# See detailed instructions here: https://github.com/danny-avila/chatgpt-clone/blob/main/docs/features/plugins/google_search.md # See detailed instructions here: https://github.com/danny-avila/LibreChat/blob/main/docs/features/plugins/google_search.md
GOOGLE_API_KEY= GOOGLE_API_KEY=
GOOGLE_CSE_ID= GOOGLE_CSE_ID=
# StableDiffusion WebUI # StableDiffusion WebUI
# This bot supports StableDiffusion WebUI, using it's API to generated requested images. # This bot supports StableDiffusion WebUI, using it's API to generated requested images.
# See detailed instructions here: https://github.com/danny-avila/chatgpt-clone/blob/main/docs/features/plugins/stable_diffusion.md # See detailed instructions here: https://github.com/danny-avila/LibreChat/blob/main/docs/features/plugins/stable_diffusion.md
# Use "http://127.0.0.1:7860" with local install and "http://host.docker.internal:7860" for docker # Use "http://127.0.0.1:7860" with local install and "http://host.docker.internal:7860" for docker
SD_WEBUI_URL=http://host.docker.internal:7860 SD_WEBUI_URL=http://host.docker.internal:7860
@ -151,7 +151,7 @@ PROXY=
# ENABLING SEARCH MESSAGES/CONVOS # ENABLING SEARCH MESSAGES/CONVOS
# Requires the installation of the free self-hosted Meilisearch or a paid Remote Plan (Remote not tested) # Requires the installation of the free self-hosted Meilisearch or a paid Remote Plan (Remote not tested)
# The easiest setup for this is through docker-compose, which takes care of it for you. # The easiest setup for this is through docker-compose, which takes care of it for you.
SEARCH=false SEARCH=true
# REQUIRED FOR SEARCH: MeiliSearch Host, mainly for the API server to connect to the search server. # REQUIRED FOR SEARCH: MeiliSearch Host, mainly for the API server to connect to the search server.
# Replace '0.0.0.0' with 'meilisearch' if serving MeiliSearch with docker-compose. # Replace '0.0.0.0' with 'meilisearch' if serving MeiliSearch with docker-compose.

View file

@ -58,7 +58,7 @@ body:
id: terms id: terms
attributes: attributes:
label: Code of Conduct label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/danny-avila/chatgpt-clone/blob/main/documents/contributions/code_of_conduct.md) description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/danny-avila/LibreChat/blob/main/CODE_OF_CONDUCT.md)
options: options:
- label: I agree to follow this project's Code of Conduct - label: I agree to follow this project's Code of Conduct
required: true required: true

View file

@ -51,7 +51,7 @@ body:
id: terms id: terms
attributes: attributes:
label: Code of Conduct label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/danny-avila/chatgpt-clone/blob/main/documents/contributions/code_of_conduct.md) description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/danny-avila/LibreChat/blob/main/CODE_OF_CONDUCT.md)
options: options:
- label: I agree to follow this project's Code of Conduct - label: I agree to follow this project's Code of Conduct
required: true required: true

View file

@ -52,7 +52,7 @@ body:
id: terms id: terms
attributes: attributes:
label: Code of Conduct label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/danny-avila/chatgpt-clone/blob/main/documents/contributions/code_of_conduct.md) description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/danny-avila/LibreChat/blob/main/CODE_OF_CONDUCT.md)
options: options:
- label: I agree to follow this project's Code of Conduct - label: I agree to follow this project's Code of Conduct
required: true required: true

View file

@ -30,9 +30,9 @@ https://github.com/danny-avila/LibreChat/assets/110412045/c1eb0c0f-41f6-4335-b98
- Response streaming identical to ChatGPT through server-sent events - Response streaming identical to ChatGPT through server-sent events
- UI from original ChatGPT, including Dark mode - UI from original ChatGPT, including Dark mode
- AI model selection (through 5 endpoints: OpenAI API, BingAI, ChatGPT Browser, PaLM2, Plugins) - AI model selection (through 5 endpoints: OpenAI API, BingAI, ChatGPT Browser, PaLM2, Plugins)
- Create, Save, & Share custom presets - [More info on prompt presets here](https://github.com/danny-avila/chatgpt-clone/releases/tag/v0.3.0) - Create, Save, & Share custom presets - [More info on prompt presets here](https://github.com/danny-avila/LibreChat/releases/tag/v0.3.0)
- Edit and Resubmit messages with conversation branching - Edit and Resubmit messages with conversation branching
- Search all messages/conversations - [More info here](https://github.com/danny-avila/chatgpt-clone/releases/tag/v0.1.0) - Search all messages/conversations - [More info here](https://github.com/danny-avila/LibreChat/releases/tag/v0.1.0)
- Plugins now available (including web access, image generation and more) - Plugins now available (including web access, image generation and more)
--- ---
@ -98,7 +98,7 @@ Keep up with the latest updates by visiting the releases page - [Releases](https
* [Code Standards and Conventions](docs/contributions/coding_conventions.md) * [Code Standards and Conventions](docs/contributions/coding_conventions.md)
* [Testing](docs/contributions/testing.md) * [Testing](docs/contributions/testing.md)
* [Security](SECURITY.md) * [Security](SECURITY.md)
* [Trello Board](https://trello.com/b/17z094kq/chatgpt-clone) * [Trello Board](https://trello.com/b/17z094kq/LibreChate)
</details> </details>
@ -106,7 +106,7 @@ Keep up with the latest updates by visiting the releases page - [Releases](https
## Star History ## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=danny-avila/chatgpt-clone&type=Date)](https://star-history.com/#danny-avila/chatgpt-clone&Date) [![Star History Chart](https://api.star-history.com/svg?repos=danny-avila/LibreChat&type=Date)](https://star-history.com/#danny-avila/LibreChat&Date)
--- ---
@ -128,6 +128,6 @@ For new features, components, or extensions, please open an issue and discuss be
This project exists in its current state thanks to all the people who contribute This project exists in its current state thanks to all the people who contribute
--- ---
<a href="https://github.com/danny-avila/chatgpt-clone/graphs/contributors"> <a href="https://github.com/danny-avila/LibreChat/graphs/contributors">
<img src="https://contrib.rocks/image?repo=danny-avila/chatgpt-clone" /> <img src="https://contrib.rocks/image?repo=danny-avila/LibreChat" />
</a> </a>

View file

@ -8,12 +8,12 @@
{ {
"authField": "GOOGLE_CSE_ID", "authField": "GOOGLE_CSE_ID",
"label": "Google CSE ID", "label": "Google CSE ID",
"description": "This is your Google Custom Search Engine ID. For instructions on how to obtain this, see <a href='https://github.com/danny-avila/chatgpt-clone/blob/main/guides/GOOGLE_SEARCH.md'>Our Docs</a>." "description": "This is your Google Custom Search Engine ID. For instructions on how to obtain this, see <a href='https://github.com/danny-avila/LibreChat/blob/main/docs/features/plugins/google_search.md'>Our Docs</a>."
}, },
{ {
"authField": "GOOGLE_API_KEY", "authField": "GOOGLE_API_KEY",
"label": "Google API Key", "label": "Google API Key",
"description": "This is your Google Custom Search API Key. For instructions on how to obtain this, see <a href='https://github.com/danny-avila/chatgpt-clone/blob/main/guides/GOOGLE_SEARCH.md'>Our Docs</a>." "description": "This is your Google Custom Search API Key. For instructions on how to obtain this, see <a href='https://github.com/danny-avila/LibreChat/blob/main/docs/features/plugins/google_search.md'>Our Docs</a>."
} }
] ]
}, },

View file

@ -97,7 +97,7 @@ Defines Mongoose models to represent data entities and their relationships.
### Data Services ### Data Services
Use the conventions found in the `data-provider` directory for handling data services. For more information, see [this article](https://www.danorlandoblog.com/chatgpt-clone-data-services-with-react-query/) which describes the methodology used. Use the conventions found in the `data-provider` directory for handling data services. For more information, see [this article](https://www.danorlandoblog.com/building-data-services-for-librechat-with-react-query/) which describes the methodology used.
### State Management ### State Management

View file

@ -1,6 +1,6 @@
# Plugins Endpoint # Plugins Endpoint
![image](https://github.com/danny-avila/chatgpt-clone/assets/110412045/0ba6c38c-4014-4c3a-a671-d2d64bb2490a) ![image](https://github.com/danny-avila/LibreChat/assets/110412045/0ba6c38c-4014-4c3a-a671-d2d64bb2490a)
The plugins endpoint opens the door to prompting LLMs in new ways other than traditional input/output prompting. The plugins endpoint opens the door to prompting LLMs in new ways other than traditional input/output prompting.
@ -17,17 +17,17 @@ More than this, you can use this endpoint for changing your conversation setting
The LLM process when using Plugins is illustrated below. The LLM process when using Plugins is illustrated below.
![Untitled-2023-06-04-1543(1)](https://github.com/danny-avila/chatgpt-clone/assets/110412045/88483ba0-6b09-43dd-9b70-fb9778871c91) ![Untitled-2023-06-04-1543(1)](https://github.com/danny-avila/LibreChat/assets/110412045/88483ba0-6b09-43dd-9b70-fb9778871c91)
**When you open the settings with the Plugins endpoint selected, you will view the default settings for the Completion Phase.** **When you open the settings with the Plugins endpoint selected, you will view the default settings for the Completion Phase.**
Clicking on **"Show Agent Settings"** will allow you to modify parameters for the thinking phase Clicking on **"Show Agent Settings"** will allow you to modify parameters for the thinking phase
![image](https://github.com/danny-avila/chatgpt-clone/assets/110412045/3d0a1e23-b111-459a-a1bc-19ff9262c2b6) ![image](https://github.com/danny-avila/LibreChat/assets/110412045/3d0a1e23-b111-459a-a1bc-19ff9262c2b6)
--- ---
![image](https://github.com/danny-avila/chatgpt-clone/assets/110412045/87e5ba8a-194b-4ca3-bec4-820f7434c8c8) ![image](https://github.com/danny-avila/LibreChat/assets/110412045/87e5ba8a-194b-4ca3-bec4-820f7434c8c8)
- You can specify which plugins you would like to select from by installing/uninstalling them in the Plugin store - You can specify which plugins you would like to select from by installing/uninstalling them in the Plugin store
- See this guide on how to create your own plugins (WIP) - See this guide on how to create your own plugins (WIP)
@ -68,10 +68,10 @@ Clicking on **"Show Agent Settings"** will allow you to modify parameters for th
### Showcase ### Showcase
![image](https://github.com/danny-avila/chatgpt-clone/assets/110412045/c5d3aba8-8ab5-4f41-a1fa-202ece5849db) ![image](https://github.com/danny-avila/LibreChat/assets/110412045/c5d3aba8-8ab5-4f41-a1fa-202ece5849db)
![image](https://github.com/danny-avila/chatgpt-clone/assets/110412045/9ddeb874-4323-45a3-b2aa-5492bc324716) ![image](https://github.com/danny-avila/LibreChat/assets/110412045/9ddeb874-4323-45a3-b2aa-5492bc324716)
--- ---

View file

@ -207,12 +207,12 @@ Here are a few customConstructors, which have varying initializations
{ {
"authField": "GOOGLE_CSE_ID", "authField": "GOOGLE_CSE_ID",
"label": "Google CSE ID", "label": "Google CSE ID",
"description": "This is your Google Custom Search Engine ID. For instructions on how to obtain this, see <a href='https://github.com/danny-avila/chatgpt-clone/blob/main/guides/GOOGLE_SEARCH.md'>Our Docs</a>." "description": "This is your Google Custom Search Engine ID. For instructions on how to obtain this, see <a href='https://github.com/danny-avila/LibreChat/blob/main/docs/features/plugins/google_search.md'>Our Docs</a>."
}, },
{ {
"authField": "GOOGLE_API_KEY", "authField": "GOOGLE_API_KEY",
"label": "Google API Key", "label": "Google API Key",
"description": "This is your Google Custom Search API Key. For instructions on how to obtain this, see <a href='https://github.com/danny-avila/chatgpt-clone/blob/main/guides/GOOGLE_SEARCH.md'>Our Docs</a>." "description": "This is your Google Custom Search API Key. For instructions on how to obtain this, see <a href='https://github.com/danny-avila/LibreChat/blob/main/docs/features/plugins/google_search.md'>Our Docs</a>."
} }
] ]
}, },

View file

@ -55,13 +55,13 @@ With the docker deployment you can skip step 2 and step 3, use the setup instruc
- Use `SD_WEBUI_URL=http://127.0.0.1:7860` in the `.env` file - Use `SD_WEBUI_URL=http://127.0.0.1:7860` in the `.env` file
- Or `http://127.0.0.1:7860` from the webui - Or `http://127.0.0.1:7860` from the webui
![image](https://github.com/danny-avila/chatgpt-clone/assets/110412045/e33e0133-66c1-4781-9ca8-bbd8c174579c) ![image](https://github.com/danny-avila/LibreChat/assets/110412045/e33e0133-66c1-4781-9ca8-bbd8c174579c)
![image](https://github.com/danny-avila/chatgpt-clone/assets/110412045/a075e5b9-d648-405d-96cf-178af792aabc) ![image](https://github.com/danny-avila/LibreChat/assets/110412045/a075e5b9-d648-405d-96cf-178af792aabc)
## 5. Select the plugin and enjoy! ## 5. Select the plugin and enjoy!
![image](https://github.com/danny-avila/chatgpt-clone/assets/110412045/bbdffdc7-57b0-459e-87c2-c3c2871b74cb) ![image](https://github.com/danny-avila/LibreChat/assets/110412045/bbdffdc7-57b0-459e-87c2-c3c2871b74cb)
--- ---

View file

@ -11,13 +11,13 @@ An AppID must be supplied in all calls to the Wolfram|Alpha API.
- Alternatively: you (the admin) can set the value in `\.env` to bypass the prompt - Alternatively: you (the admin) can set the value in `\.env` to bypass the prompt
- `WOLFRAM_APP_ID=your_app_id` - `WOLFRAM_APP_ID=your_app_id`
![image](https://github.com/danny-avila/chatgpt-clone/assets/110412045/e33e0133-66c1-4781-9ca8-bbd8c174579c) ![image](https://github.com/danny-avila/LibreChat/assets/110412045/e33e0133-66c1-4781-9ca8-bbd8c174579c)
![image](https://github.com/danny-avila/chatgpt-clone/assets/110412045/a075e5b9-d648-405d-96cf-178af792aabc) ![image](https://github.com/danny-avila/LibreChat/assets/110412045/a075e5b9-d648-405d-96cf-178af792aabc)
## 5. Select the plugin and enjoy! ## 5. Select the plugin and enjoy!
![image](https://github.com/danny-avila/chatgpt-clone/assets/110412045/fe5626ce-dfc5-4b0f-b203-e954975ff551) ![image](https://github.com/danny-avila/LibreChat/assets/110412045/fe5626ce-dfc5-4b0f-b203-e954975ff551)
--- ---

View file

@ -85,23 +85,23 @@ Setup the app:
- Open a text editor - Open a text editor
- Paste the following code in a new document - Paste the following code in a new document
- Put your MeiliSearch master key instead of "your_master_key_goes_here" - Put your MeiliSearch master key instead of "your_master_key_goes_here"
- Save the file as "/home/user/chatgpt-clone/chatgpt-clone.sh" - Save the file as "/home/user/LibreChat/LibreChat.sh"
- You can make a shortcut of this shell script and put it anywhere - You can make a shortcut of this shell script and put it anywhere
``` ```
#!/bin/bash #!/bin/bash
# the meilisearch executable needs to be at the root of the chatgpt-clone directory # the meilisearch executable needs to be at the root of the LibreChat directory
gnome-terminal --tab --title="MeiliSearch" --command="bash -c 'meilisearch --master-key your_master_key_goes_here'" gnome-terminal --tab --title="MeiliSearch" --command="bash -c 'meilisearch --master-key your_master_key_goes_here'"
# ↑↑↑ meilisearch is the name of the meilisearch executable, put your own master key there # ↑↑↑ meilisearch is the name of the meilisearch executable, put your own master key there
gnome-terminal --tab --title="ChatGPT-Clone" --working-directory=/home/user/chatgpt-clone/ --command="bash -c 'npm run backend'" gnome-terminal --tab --title="LibreChat" --working-directory=/home/user/LibreChat/ --command="bash -c 'npm run backend'"
# this shell script goes at the root of the chatgpt-clone directory (/home/user/chatgpt-clone/) # this shell script goes at the root of the LibreChat directory (/home/user/LibreChat/)
``` ```
## Update the app version ## Update the app version
If you update the chatgpt-clone project files, manually redo the npm ci and npm run frontend steps. If you update the LibreChat project files, manually redo the npm ci and npm run frontend steps.
## ##