Skip to content

docs(readme): update commands to use yarn instead of npm #1018

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

docs(readme): update commands to use yarn instead of npm #1018

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5787d7b
docs(readme): update commands to use yarn instead of npm
Hariom01010 Aug 30, 2025
838b81b
docs(readme): update docs to use yarn instead of npm
Hariom01010 Aug 30, 2025
7199953
chore: update the command to install dependencies
AnujChhikara Aug 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,26 +21,26 @@ 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
npm install
yarn install
```

This will install all required packages for the proxy server and other tooling.

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).

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.

Expand Down
Loading