docs: add install fallback note in README #244
Conversation
📝 WalkthroughWalkthroughUpdated README.md Acknowledgements with troubleshooting steps for dependency installation: instructs running Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
179-182: Consider moving this note to a more discoverable location.The
npm install --legacy-peer-depsnote is currently placed in the Acknowledgements section, which is semantically incorrect for a troubleshooting tip. Additionally, there's no prior mention of npm or Node.js setup in the "Running the Server" section (which only covers Docker prerequisites).To maximize discoverability and usefulness, I recommend:
- Moving this note to the "Running the Server" section or creating a new "Troubleshooting" subsection within "Getting Started"
- Adding context explaining when/why this command is needed (e.g., "If npm dependency installation fails with peer dependency conflicts, try...") so readers understand the applicability
Can you clarify whether npm is required for running the production Databus server, or if this is only needed for development/contributor workflows? If npm is a prerequisite, it should also be added to the Requirements subsection (around line 85-91).
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.md (2)
179-186: Relocate troubleshooting section to align with installation context.While the troubleshooting guidance is helpful, placing it under "Acknowledgements" (which documents funding/grants) disrupts the document's logical flow. This content should either be colocated with the "Running the Server" section (lines 84–103) or placed in a dedicated "Troubleshooting" section earlier in the document.
Consider moving these lines to the end of the "Running the Server" section and adding more context:
### Starting the Databus Server Clone the repository or download the `docker-compose.yml` and `.env` files. Both files need to exist in the same directory. Navigate to the directory with the files (root of the repo). run:docker-compose up
The Databus should be available at `http://localhost:3000`. + #### Troubleshooting Dependency Issues + + If you encounter peer dependency conflicts during setup, run: + ```bash + npm install --legacy-peer-deps + ``` + + For MongoDB-related issues, verify your MongoDB version: + ```bash + mongod --version + ``` + Ensure your MongoDB version matches the requirements in the project documentation.Then remove it from the Acknowledgements section.
183-186: Clarify MongoDB version check guidance.The instruction to check MongoDB version lacks actionable context. Consider adding clarification about which versions are required or expected, and what users should do if their version doesn't match.
Example improvement:
> **Check MongoDB version (for troubleshooting)** > ```bash > mongod --version > ``` + > Ensure it meets the project's minimum MongoDB version requirement (see `.env` or `docker-compose.yml`).
1 participant
This PR adds a fallback npm install command to help new contributors
resolve dependency installation issues. No code changes, only a
documentation improvement.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.
this pr solves issues #245