From 731304f96a174d880e608dfd2e73fa10ef35d904 Mon Sep 17 00:00:00 2001 From: Fuegovic <32828263+fuegovic@users.noreply.github.com> Date: Thu, 22 Jun 2023 20:12:25 -0400 Subject: [PATCH] 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 --- .env.example | 6 +++--- .github/ISSUE_TEMPLATE/BUG-REPORT.yml | 2 +- .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml | 2 +- .github/ISSUE_TEMPLATE/QUESTION.yml | 2 +- README.md | 12 ++++++------ api/app/langchain/tools/manifest.json | 4 ++-- docs/contributions/coding_conventions.md | 2 +- docs/features/plugins/introduction.md | 12 ++++++------ docs/features/plugins/make_your_own.md | 4 ++-- docs/features/plugins/stable_diffusion.md | 6 +++--- docs/features/plugins/wolfram.md | 6 +++--- docs/install/linux_install.md | 10 +++++----- 12 files changed, 34 insertions(+), 34 deletions(-) diff --git a/.env.example b/.env.example index 3baabd3fa9..f084f3dc8a 100644 --- a/.env.example +++ b/.env.example @@ -116,13 +116,13 @@ CREDS_IV=e2341419ec3dd3d19b13a1a87fafcbfb # AI-Assisted Google Search # 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_CSE_ID= # StableDiffusion WebUI # 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 SD_WEBUI_URL=http://host.docker.internal:7860 @@ -151,7 +151,7 @@ PROXY= # ENABLING SEARCH MESSAGES/CONVOS # 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. -SEARCH=false +SEARCH=true # 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. diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml index 1ed62775af..fc60ffb0a0 100644 --- a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml @@ -58,7 +58,7 @@ body: id: terms attributes: 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: - label: I agree to follow this project's Code of Conduct required: true diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml index f7c18184d0..3fd3a438c7 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml +++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml @@ -51,7 +51,7 @@ body: id: terms attributes: 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: - label: I agree to follow this project's Code of Conduct required: true diff --git a/.github/ISSUE_TEMPLATE/QUESTION.yml b/.github/ISSUE_TEMPLATE/QUESTION.yml index 23a1a7be50..d808787d38 100644 --- a/.github/ISSUE_TEMPLATE/QUESTION.yml +++ b/.github/ISSUE_TEMPLATE/QUESTION.yml @@ -52,7 +52,7 @@ body: id: terms attributes: 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: - label: I agree to follow this project's Code of Conduct required: true diff --git a/README.md b/README.md index 836e5963c6..fac38d74b1 100644 --- a/README.md +++ b/README.md @@ -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 - UI from original ChatGPT, including Dark mode - 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 -- 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) --- @@ -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) * [Testing](docs/contributions/testing.md) * [Security](SECURITY.md) - * [Trello Board](https://trello.com/b/17z094kq/chatgpt-clone) + * [Trello Board](https://trello.com/b/17z094kq/LibreChate) @@ -106,7 +106,7 @@ Keep up with the latest updates by visiting the releases page - [Releases](https ## 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 --- - - + + diff --git a/api/app/langchain/tools/manifest.json b/api/app/langchain/tools/manifest.json index 7fa871b79c..e0924383d4 100644 --- a/api/app/langchain/tools/manifest.json +++ b/api/app/langchain/tools/manifest.json @@ -8,12 +8,12 @@ { "authField": "GOOGLE_CSE_ID", "label": "Google CSE ID", - "description": "This is your Google Custom Search Engine ID. For instructions on how to obtain this, see Our Docs." + "description": "This is your Google Custom Search Engine ID. For instructions on how to obtain this, see Our Docs." }, { "authField": "GOOGLE_API_KEY", "label": "Google API Key", - "description": "This is your Google Custom Search API Key. For instructions on how to obtain this, see Our Docs." + "description": "This is your Google Custom Search API Key. For instructions on how to obtain this, see Our Docs." } ] }, diff --git a/docs/contributions/coding_conventions.md b/docs/contributions/coding_conventions.md index f7a4ce0c05..5335f8ecd5 100644 --- a/docs/contributions/coding_conventions.md +++ b/docs/contributions/coding_conventions.md @@ -97,7 +97,7 @@ Defines Mongoose models to represent data entities and their relationships. ### 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 diff --git a/docs/features/plugins/introduction.md b/docs/features/plugins/introduction.md index 412da0cdbe..92242702f9 100644 --- a/docs/features/plugins/introduction.md +++ b/docs/features/plugins/introduction.md @@ -1,6 +1,6 @@ # 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. @@ -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. -![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.** 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 - 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 -![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) --- diff --git a/docs/features/plugins/make_your_own.md b/docs/features/plugins/make_your_own.md index 221095119a..d9f34fa002 100644 --- a/docs/features/plugins/make_your_own.md +++ b/docs/features/plugins/make_your_own.md @@ -207,12 +207,12 @@ Here are a few customConstructors, which have varying initializations { "authField": "GOOGLE_CSE_ID", "label": "Google CSE ID", - "description": "This is your Google Custom Search Engine ID. For instructions on how to obtain this, see Our Docs." + "description": "This is your Google Custom Search Engine ID. For instructions on how to obtain this, see Our Docs." }, { "authField": "GOOGLE_API_KEY", "label": "Google API Key", - "description": "This is your Google Custom Search API Key. For instructions on how to obtain this, see Our Docs." + "description": "This is your Google Custom Search API Key. For instructions on how to obtain this, see Our Docs." } ] }, diff --git a/docs/features/plugins/stable_diffusion.md b/docs/features/plugins/stable_diffusion.md index cb46d27791..de8bda9094 100644 --- a/docs/features/plugins/stable_diffusion.md +++ b/docs/features/plugins/stable_diffusion.md @@ -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 - 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/chatgpt-clone/assets/110412045/a075e5b9-d648-405d-96cf-178af792aabc) +![image](https://github.com/danny-avila/LibreChat/assets/110412045/e33e0133-66c1-4781-9ca8-bbd8c174579c) +![image](https://github.com/danny-avila/LibreChat/assets/110412045/a075e5b9-d648-405d-96cf-178af792aabc) ## 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) --- diff --git a/docs/features/plugins/wolfram.md b/docs/features/plugins/wolfram.md index e144f1b03e..37808587b0 100644 --- a/docs/features/plugins/wolfram.md +++ b/docs/features/plugins/wolfram.md @@ -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 - `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/chatgpt-clone/assets/110412045/a075e5b9-d648-405d-96cf-178af792aabc) +![image](https://github.com/danny-avila/LibreChat/assets/110412045/e33e0133-66c1-4781-9ca8-bbd8c174579c) +![image](https://github.com/danny-avila/LibreChat/assets/110412045/a075e5b9-d648-405d-96cf-178af792aabc) ## 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) --- diff --git a/docs/install/linux_install.md b/docs/install/linux_install.md index 08d48d01ed..550b2f49b0 100644 --- a/docs/install/linux_install.md +++ b/docs/install/linux_install.md @@ -85,23 +85,23 @@ Setup the app: - Open a text editor - Paste the following code in a new document - 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 ``` #!/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'" # ↑↑↑ 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'" -# this shell script goes at the root of the chatgpt-clone directory (/home/user/chatgpt-clone/) +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 LibreChat directory (/home/user/LibreChat/) ``` ## 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. ##