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

Hariom01010 · 2025-08-30T19:38:40Z

Date: 31 Aug 2025

Developer Name: @Hariom01010

Issue Ticket Number

Closes Update README to use Yarn commands instead of npm #1017

Description

Replaced npm commands with yarn equivalents in the README for consistency
with the project’s package manager.

Documentation Updated?

Yes
No

Under Feature Flag

Yes
No

Database Changes

Yes
No

Breaking Changes

Yes
No

Development Tested?

Yes
No

Screenshots

Screenshot 1

Test Coverage

Screenshot 1

Additional Notes

Description by Korbit AI

What change is being made?

Update the README to replace npm commands with yarn commands for installation and development (yarn install, yarn dev) and adjust the related notes accordingly.

Why are these changes being made?

Reflects the project's dependency manager choice by switching from npm to Yarn; ensures readers use the correct commands and expectations for running both the proxy and frontend servers.

Is this description stale? Ask me to generate a new description by commenting /korbit-generate-pr-description

coderabbitai · 2025-08-30T19:38:48Z

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Summary by CodeRabbit

Documentation
- Updated Quick Start instructions to use Yarn commands instead of npm for installation and running the development proxy server.
- Replaced “npm install” with “yarn” and “npm run dev” with “yarn dev” to streamline setup for Yarn users.
- No functional or behavioral changes; guidance and steps remain the same.

Walkthrough

Updated README Quick Start commands to use Yarn instead of npm: replaced "npm install" with "yarn" and "npm run dev" with "yarn dev". No code or control-flow changes.

Changes

Cohort / File(s)	Summary of Changes
Docs: README updates `README.md`	Replaced npm commands with Yarn equivalents in Quick Start: `npm install` → `yarn`, `npm run dev` → `yarn dev`.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Assessment against linked issues

Objective	Addressed	Explanation
Replace `npm install` with `yarn` in Quick Start section (#1017)	✅
Replace `npm run dev` with `yarn dev` in Quick Start section (#1017)	✅

Poem

I twitch my whiskers—docs align, hooray!
From npm to yarn, we hop the tidy way.
Quick Start now hums with a lighter tread,
"yarn" to install, "yarn dev" ahead.
Carrot-commits bundled neat and warm—
I bound through README, weaving form.
Soft thumps approve this fluffy norm. 🥕🐇

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch update-readme

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

korbit-ai

I've completed my review and didn't find any issues... but I did find this kitten.

    |\__/,|   (`\
  _.|o o  |_   ) )
-(((---(((--------

Check out our docs on how you can make Korbit work best for you and your team.

Loving Korbit!? Share us on LinkedIn Reddit and X

coderabbitai

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (3)

README.md (3)

43-43: Leftover npm command reference.

Change inline reference to match step 4.

Apply:

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

17-19: Add Yarn and Node.js to prerequisites.

Without these, the Yarn commands won’t work for new contributors.

Proposed addition:

 - [Visual Studio Code](https://code.visualstudio.com/) installed on your machine.
 - [Live Server extension](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer) for VS Code.
+- Node.js 18 LTS or later.
+- Yarn package manager (enable via `corepack enable` on Node 16.10+ or install from yarnpkg.com).

22-24: Normalize spacing in ordered list (double spaces after numbers).

Minor readability/consistency nit; also flagged by the linter.

Apply:

-1.  **Clone this repository** to your local machine.
-2.  **Open the project folder** in VS Code.
-3. **Install dependencies with Yarn** by running the following command in your project directory:
+1. **Clone this repository** to your local machine.
+2. **Open the project folder** in VS Code.
+3. **Install dependencies with Yarn** by running the following command in your project directory:

-4.  **Start the proxy server** by running:
+4. **Start the proxy server** by running:

-5.  **Start the frontend server:** Click the **"Go Live" button** in the bottom-right corner of VS Code.
+5. **Start the frontend server:** Click the **"Go Live" button** in the bottom-right corner of VS Code.

Also applies to: 32-32, 40-40

📜 Review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

💡 Knowledge Base configuration:

MCP integration is disabled by default for public repositories
Jira integration is disabled by default for public repositories
Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 80ed80f and 5787d7b.

📒 Files selected for processing (1)

README.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

README.md

[grammar] ~30-~30: Use correct spacing
Context: ... for the proxy server and other tooling. 4. Start the proxy server by running: ...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

[grammar] ~32-~32: Use correct spacing
Context: ... Start the proxy server by running: bash yarn dev This command starts the proxy server, wh...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: build-test (22.x)

🔇 Additional comments (2)

README.md (2)

27-28: Good switch to Yarn install.

Command matches the project’s package manager.

35-36: Good switch to Yarn dev.

Start command is consistent with Yarn.

README.md

cloudflare-workers-and-pages · 2025-08-30T19:44:16Z

Deploying dashboard-rds with Cloudflare Pages

Latest commit:	`21a1bd8`
Status:	✅ Deploy successful!
Preview URL:	https://25b6bfed.dashboard-rds.pages.dev
Branch Preview URL:	https://update-readme.dashboard-rds.pages.dev

View logs

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

5787d7b

Hariom01010 self-assigned this Aug 30, 2025

Hariom01010 added the documentation Improvements or additions to documentation label Aug 30, 2025

korbit-ai bot reviewed Aug 30, 2025

View reviewed changes

coderabbitai bot reviewed Aug 30, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

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

838b81b

chore: update the command to install dependencies

7199953

AnujChhikara approved these changes Aug 30, 2025

View reviewed changes

Merge branch 'develop' into update-readme

21a1bd8

JC-Coder approved these changes Oct 29, 2025

View reviewed changes

iamitprakash approved these changes Oct 30, 2025

View reviewed changes

iamitprakash merged commit 3116697 into develop Oct 30, 2025
5 checks passed

iamitprakash deleted the update-readme branch October 30, 2025 07:26

AnujChhikara mentioned this pull request Nov 1, 2025

Dev to Main Sync #1026

Merged

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

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

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

Uh oh!

Hariom01010 commented Aug 30, 2025 •

edited by korbit-ai bot

Loading

Uh oh!

coderabbitai bot commented Aug 30, 2025 •

edited

Loading

Review skipped

Uh oh!

korbit-ai bot left a comment

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

cloudflare-workers-and-pages bot commented Aug 30, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

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

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

Uh oh!

Conversation

Hariom01010 commented Aug 30, 2025 • edited by korbit-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue Ticket Number

Description

Documentation Updated?

Under Feature Flag

Database Changes

Breaking Changes

Development Tested?

Screenshots

Test Coverage

Additional Notes

Description by Korbit AI

What change is being made?

Why are these changes being made?

Uh oh!

coderabbitai bot commented Aug 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Summary by CodeRabbit

Walkthrough

Changes

Estimated code review effort

Assessment against linked issues

Poem

Uh oh!

korbit-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cloudflare-workers-and-pages bot commented Aug 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying dashboard-rds with Cloudflare Pages

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Hariom01010 commented Aug 30, 2025 •

edited by korbit-ai bot

Loading

coderabbitai bot commented Aug 30, 2025 •

edited

Loading

cloudflare-workers-and-pages bot commented Aug 30, 2025 •

edited

Loading