Skip to content

Commit 3116697

Browse files
authored
Merge pull request #1018 from Real-Dev-Squad/update-readme
docs(readme): update commands to use yarn instead of npm
1 parent f003021 commit 3116697

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,26 +21,26 @@ You can run the dashboard locally in just a few steps:
2121

2222
1. **Clone this repository** to your local machine.
2323
2. **Open the project folder** in VS Code.
24-
3. **Install npm dependencies** by running the following command in your project directory:
24+
3. **Install yarn dependencies** by running the following command in your project directory:
2525

2626
```bash
27-
npm install
27+
yarn install
2828
```
2929

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

3232
4. **Start the proxy server** by running:
3333

3434
```bash
35-
npm run dev
35+
yarn dev
3636
```
3737

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

4040
5. **Start the frontend server:** Click the **"Go Live" button** in the bottom-right corner of VS Code.
4141
- This will open the dashboard in your browser and automatically reload when you make changes.
4242
- If you don't see the "Go Live" button, ensure the Live Server extension is installed and enabled.
43-
- **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.
43+
- **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.
4444
4545
> **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.
4646

0 commit comments

Comments
 (0)