chore: NPM Workspaces and scripts (danny-avila#244)

* chore: NPM Workspaces and scripts - Allows everything to be run in the root directory * chore:Update package-lock after workspace change * docs: Minor docs typo fix - most people run in dev mode, ie vite runs the server, this defaults to that method
petegq · May 12, 2023 · 95c9756 · 95c9756
1 parent 8bb4d7d
commit 95c9756
Show file tree

Hide file tree

Showing 8 changed files with 26,595 additions and 134 deletions.
diff --git a/.gitignore b/.gitignore
@@ -59,6 +59,7 @@ src/style - official.css
 /playwright/.cache/
 .DS_Store
 *.code-workspace
+.idea
 
 # meilisearch
 meilisearch

diff --git a/api/package.json b/api/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "chatgpt-clone",
+  "name": "chat-backend",
   "version": "0.4.2",
   "description": "",
   "main": "server/index.js",

diff --git a/client/package.json b/client/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "chatgpt-clone",
+  "name": "chat-frontend",
   "version": "0.4.2",
   "description": "",
   "type": "module",

diff --git a/documents/install/linux_install.md b/documents/install/linux_install.md
@@ -88,15 +88,13 @@ You will need all your credentials, (API keys, access tokens, and MongoDB Connec
 
 ## Run the project
 
-### Using the command line
-
-1. Run `npm ci` in the "/home/user/chatgpt-clone/api" directory
-2. Run `npm ci` in the "/home/user/chatgpt-clone/client" directory
-3. Run `npm run build` in the "/home/user/chatgpt-clone/client"
-4. Run `meilisearch --master-key put_your_meilesearch_Master_Key_here` in the "/home/user/chat
-5. Run "meilisearch --master-key put_your_meilesearch_Master_Key_here" in the "/home/user/chatgpt-clone" directory (Only if SEARCH=TRUE)
-6. Run npm start in the "/home/user/chatgpt-clone/api" directory
-7. Visit http://localhost:3080 (default port) & enjoy
+### Using the command line (in the root directory)
+
+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
 
 ### Using a shell script
 

diff --git a/documents/install/mac_install.md b/documents/install/mac_install.md
@@ -58,14 +58,8 @@ 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 in both the api and client directories by running:
-
-```
-cd api && npm ci && cd ..
-cd client && npm ci && cd ..
-```
-
-  - Build the client by running cd client && npm run build && cd ..
+  - Run npm ci root directory `npm ci`
+  - Build the client by running `npm run frontend-dev`
 
 **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.

diff --git a/documents/install/windows_install.md b/documents/install/windows_install.md
@@ -66,15 +66,13 @@ You will need all your credentials, (API keys, access tokens, and Mongo Connecti
 
 ### Run the app
 
-#### Using the command line
+### Using the command line (in the root directory)
 
-- **Run** `npm ci` in the "C:/chatgpt-clone/api" directory
-- **Run** `npm ci` in the "C:/chatgpt-clone/client" directory
-- **Run** `npm run build` in the "C:/chatgpt-clone/client"
-- **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
-
-- **Visit** http://localhost:3080 (default port) & enjoy
+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
 
 #### Using a batch file