Skip to content

Conversation

@mrsarthi
Copy link

@mrsarthi mrsarthi commented Dec 1, 2025

Description

Added a warning to the README.md to clarify that this project is a monorepo. New contributors often try running npm install in the root directory, which fails. This update explicitly instructs users to navigate into client/ or blockchain/ before installing dependencies.

Fixes # (issue)
Small doc fix, no issue created

Type of change

Please mark the options that are relevant.

  • Updated UI/UX
  • Improved the business logic of code
  • Added new feature
  • Other

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

Summary by CodeRabbit

  • Documentation
    • Updated README to clarify monorepo structure and setup procedures for new users. Now includes explicit step-by-step guidance directing users to run npm install only within individual project subdirectories (client/ or blockchain/) rather than at the repository root, preventing common setup issues and ensuring consistent development environments.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Dec 1, 2025

Walkthrough

Documentation update to README.md clarifying monorepo structure and npm installation instructions. Users are now directed to run npm install only within the client/ or blockchain/ subdirectories rather than at the repository root.

Changes

Cohort / File(s) Change Summary
Documentation
README.md
Added note explaining monorepo structure and correcting npm install instructions to specify client/ or blockchain/ directories instead of root

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A monorepo maze, now clearly signed,
The root holds secrets, the folders unwind,
Install not here, but venture down deep,
To client and blockchain, where packages sleep! 🐰✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'add user warning to the readme file' is directly related to the main change in the pull request, which adds a warning note to the README.md explaining the monorepo structure and npm install instructions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 49aa080 and c9354a6.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🔇 Additional comments (1)
README.md (1)

85-85: Documentation update is clear and well-placed.

The warning effectively communicates the monorepo structure constraint and prevents new contributors from making the common mistake of running npm install in the root directory. The placement immediately after the npm install command in the Backend section is ideal, and the Backend pattern reinforces the same behavior for the Frontend section (where contributors already see cd client before the equivalent command).

The wording is direct and actionable: "You must navigate into client/ or blockchain/ before running installation commands. Do not run npm install in the root directory."


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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant