docs(readme): update commands to use yarn instead of npm #1018
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Summary by CodeRabbit
WalkthroughUpdated 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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Assessment against linked issues
Poem
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![korbit-ai[bot]](https://avatars.githubusercontent.com/in/322216?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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.
📒 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.
Deploying dashboard-rds with
|
| Latest commit: |
7199953
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://7bc29f54.dashboard-rds.pages.dev |
| Branch Preview URL: | https://update-readme.dashboard-rds.pages.dev |
Date: 31 Aug 2025
Developer Name: @Hariom01010
Issue Ticket Number
Description
Replaced npm commands with yarn equivalents in the README for consistency
with the project’s package manager.
Documentation Updated?
Under Feature Flag
Database Changes
Breaking Changes
Development Tested?
Screenshots
Screenshot 1
Test Coverage
Screenshot 1
Additional Notes
Description by Korbit AI
What change is being made?
Update README commands to use
yarninstead ofnpmfor installation and starting the development server.Why are these changes being made?
Switching to
yarnreflects a standardized approach across the project for package management, as it may offer better performance and reliability compared tonpm. This change ensures consistency throughout the development process.