From 5787d7b2874e37190d6a386fa66a3e8e45d2c417 Mon Sep 17 00:00:00 2001 From: Hariom Vashista Date: Sun, 31 Aug 2025 01:02:51 +0530 Subject: [PATCH 1/3] docs(readme): update commands to use yarn instead of npm --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2feaf0b5..8c329b75 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ You can run the dashboard locally in just a few steps: 3. **Install npm dependencies** by running the following command in your project directory: ```bash - npm install + yarn ``` This will install all required packages for the proxy server and other tooling. @@ -32,7 +32,7 @@ You can run the dashboard locally in just a few steps: 4. **Start the proxy server** by running: ```bash - npm run dev + yarn dev ``` This command starts the proxy server, which is necessary for API calls from the frontend to the backend (see the "Proxying API Requests" section below for more details). From 838b81be48732bb9fdc768bf61feb33fb53b2f47 Mon Sep 17 00:00:00 2001 From: Hariom Vashista Date: Sun, 31 Aug 2025 01:13:32 +0530 Subject: [PATCH 2/3] docs(readme): update docs to use yarn instead of npm --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8c329b75..f3b9937b 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ You can run the dashboard locally in just a few steps: 1. **Clone this repository** to your local machine. 2. **Open the project folder** in VS Code. -3. **Install npm dependencies** by running the following command in your project directory: +3. **Install yarn dependencies** by running the following command in your project directory: ```bash yarn @@ -40,7 +40,7 @@ You can run the dashboard locally in just a few steps: 5. **Start the frontend server:** Click the **"Go Live" button** in the bottom-right corner of VS Code. - This will open the dashboard in your browser and automatically reload when you make changes. - If you don't see the "Go Live" button, ensure the Live Server extension is installed and enabled. - - **Important:** For full functionality, especially API calls, make sure both the proxy server (`npm run dev` started in step 4) and the Live Server are running concurrently. + - **Important:** For full functionality, especially API calls, make sure both the proxy server (`yarn dev` started in step 4) and the Live Server are running concurrently. > **Note:** If you only start Live Server without the proxy server, API requests from the frontend may fail due to CORS issues. Always run both servers for a complete local development experience. From 71999531d9f82391c72c0f0fbc5b0b53cec84545 Mon Sep 17 00:00:00 2001 From: Anuj Chhikara <107175639+AnujChhikara@users.noreply.github.com> Date: Sun, 31 Aug 2025 01:35:56 +0530 Subject: [PATCH 3/3] chore: update the command to install dependencies --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f3b9937b..4f943f9c 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ You can run the dashboard locally in just a few steps: 3. **Install yarn dependencies** by running the following command in your project directory: ```bash - yarn + yarn install ``` This will install all required packages for the proxy server and other tooling.