Andreas/LibreChat
1
0
Fork 0
mirror of https://github.com/danny-avila/LibreChat.git synced 2025-12-17 00:40:14 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

Merge pull request #195 from alfredo-f/alfredo/local_install

Browse source 
Update LOCAL_INSTALL structure
This commit is contained in:
Danny Avila 2023-04-29 16:34:22 -04:00 • committed by GitHub
commit fb3fc55e9f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

19
LOCAL_INSTALL.md
View file

@ -1,6 +1,8 @@
### Local # Local
- **Install the prerequisites** ## Locally run the app
### Install the prerequisites on your machine
- **Download chatgpt-clone** - **Download chatgpt-clone**
- Download the latest release here: https://github.com/danny-avila/chatgpt-clone/releases/ - Download the latest release here: https://github.com/danny-avila/chatgpt-clone/releases/
@ -51,20 +53,19 @@
- Add your previously saved MeiliSearch Master key to this line **MEILI_MASTER_KEY=** (the key is needed if search is enabled even on local install or you may encounter errors) - Add your previously saved MeiliSearch Master key to this line **MEILI_MASTER_KEY=** (the key is needed if search is enabled even on local install or you may encounter errors)
- Save the file as **"C:/chatgpt-clone/api/.env"** - Save the file as **"C:/chatgpt-clone/api/.env"**
**DO THIS ONCE AFTER EVERY UPDATE** ### Run the app
#### Using the command line
- **Run** `npm ci` in the "C:/chatgpt-clone/api" directory - **Run** `npm ci` in the "C:/chatgpt-clone/api" directory
- **Run** `npm ci` in the "C:/chatgpt-clone/client" directory - **Run** `npm ci` in the "C:/chatgpt-clone/client" directory
- **Run** `npm run build` in the "C:/chatgpt-clone/client" - **Run** `npm run build` in the "C:/chatgpt-clone/client"
**DO THIS EVERY TIME YOU WANT TO START CHATGPT-CLONE**
- **Run** `"meilisearch --master-key put_your_meilesearch_Master_Key_here"` in the "C:/chatgpt-clone" directory (Only if SEARCH=TRUE) - **Run** `"meilisearch --master-key put_your_meilesearch_Master_Key_here"` in the "C:/chatgpt-clone" directory (Only if SEARCH=TRUE)
- **Run** `npm start` in the "C:/chatgpt-clone/api" directory - **Run** `npm start` in the "C:/chatgpt-clone/api" directory
- **Visit** http://localhost:3080 (default port) & enjoy - **Visit** http://localhost:3080 (default port) & enjoy
OPTIONAL BUT RECOMMENDED #### Using a batch file
- **Make a batch file to automate the starting process** - **Make a batch file to automate the starting process**
- Open a text editor - Open a text editor
@ -85,6 +86,10 @@ start "ChatGPT-Clone" cmd /k "cd api && npm start"
REM this batch file goes at the root of the chatgpt-clone directory (C:/chatgpt-clone/) REM this batch file goes at the root of the chatgpt-clone directory (C:/chatgpt-clone/)
``` ```
## Update the app version
If you update the chatgpt-clone project files, mannually redo the `npm ci` and `npm run build` steps If you update the chatgpt-clone project files, mannually redo the `npm ci` and `npm run build` steps
# Shared
To share within network or serve as a public server, set `HOST` to `0.0.0.0` in `.env` file. To share within network or serve as a public server, set `HOST` to `0.0.0.0` in `.env` file.