From 9de7da91a7650613966e29b4dddf197006a7e1ba Mon Sep 17 00:00:00 2001 From: Fuegovic <32828263+fuegovic@users.noreply.github.com> Date: Mon, 15 May 2023 07:49:49 -0400 Subject: [PATCH] Fix: install instructions (#272) * Update windows_install.md removed -dev argument * Update mac_install.md removed `-dev` arguments * Update linux_install.md removed "-dev" argument * Update windows_install.md correction to update procedure * Update windows_install.md updat bat file instruction * Update mac_install.md update bash command * Update linux_install.md update bash script and update instructions * Update linux_install.md fix mistake in update instruction --- documents/install/linux_install.md | 16 +++++++++------- documents/install/mac_install.md | 4 ++-- documents/install/windows_install.md | 16 +++++++++------- 3 files changed, 20 insertions(+), 16 deletions(-) diff --git a/documents/install/linux_install.md b/documents/install/linux_install.md index fa1107d96..06840c256 100644 --- a/documents/install/linux_install.md +++ b/documents/install/linux_install.md @@ -89,12 +89,14 @@ You will need all your credentials, (API keys, access tokens, and MongoDB Connec ## Run the project ### Using the command line (in the root directory) - +Setup the app: 1. Run `npm ci` -2. Run `npm run frontend-dev` -3. Run `npm run backend` -4. Run `meilisearch --master-key put_your_meilesearch_Master_Key_here` (Only if SEARCH=TRUE) -5. Visit http://localhost:3080 (default port) & enjoy +2. Run `npm run frontend` + +Start the app: +1. Run `npm run backend` +2. Run `meilisearch --master-key put_your_meilesearch_Master_Key_here` (Only if SEARCH=TRUE) +3. Visit http://localhost:3080 (default port) & enjoy ### Using a shell script @@ -112,13 +114,13 @@ You will need all your credentials, (API keys, access tokens, and MongoDB Connec 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/api --command="bash -c 'npm start'" +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/) ``` ## Update the app version -If you update the chatgpt-clone project files, manually redo the npm ci and npm run build steps. +If you update the chatgpt-clone project files, manually redo the npm ci and npm run frontend steps. ## diff --git a/documents/install/mac_install.md b/documents/install/mac_install.md index 48570aa5e..a7fbf7138 100644 --- a/documents/install/mac_install.md +++ b/documents/install/mac_install.md @@ -59,7 +59,7 @@ Follow the instructions for setting up proxies, access tokens, and user system: - Create a .env file in the api directory by running cp api/.env.example api/.env and edit the file with your preferred text editor, adding the required API keys, access tokens, and MongoDB connection string - Run npm ci root directory `npm ci` - - Build the client by running `npm run frontend-dev` + - Build the client by running `npm run frontend` **Download MeiliSearch for macOS:** - You can download the latest MeiliSearch binary for macOS from their GitHub releases page: https://github.com/meilisearch/MeiliSearch/releases. Look for the file named meilisearch-macos-amd64 (or the equivalent for your system architecture) and download it. @@ -102,7 +102,7 @@ Visit http://localhost:3080 (default port) & enjoy if [ -x "$(command -v ./meilisearch)" ]; then ./meilisearch --master-key your_master_key_goes_here & fi -cd api && npm start +npm run backend ``` **Make the script executable by running** diff --git a/documents/install/windows_install.md b/documents/install/windows_install.md index 5118501c5..2a8d73a70 100644 --- a/documents/install/windows_install.md +++ b/documents/install/windows_install.md @@ -67,12 +67,14 @@ You will need all your credentials, (API keys, access tokens, and Mongo Connecti ### Run the app ### Using the command line (in the root directory) - +To setup the app: 1. Run `npm ci` -2. Run `npm run frontend-dev` -3. Run `npm run backend` -4. Run `meilisearch --master-key put_your_meilesearch_Master_Key_here` (Only if SEARCH=TRUE) -5. Visit http://localhost:3080 (default port) & enjoy +2. Run `npm run frontend` + +To use the app: +1. Run `npm run backend` +2. Run `meilisearch --master-key put_your_meilesearch_Master_Key_here` (Only if SEARCH=TRUE) +3. Visit http://localhost:3080 (default port) & enjoy #### Using a batch file @@ -90,14 +92,14 @@ start "MeiliSearch" cmd /k "meilisearch --master-key your_master_key_goes_here REM ↑↑↑ meilisearch is the name of the meilisearch executable, put your own master key there -start "ChatGPT-Clone" cmd /k "cd api && npm start" +start "ChatGPT-Clone" cmd /k "npm run backend" 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 frontend` steps ##