docs: add getting started guide for local setup #3436
Conversation
WalkthroughA new "Getting Started (Local Setup)" section was added to the README.md file, providing step-by-step instructions for setting up the project locally. This includes a list of prerequisites and initial repository cloning commands. No existing documentation was modified or removed. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches🧪 Generate unit tests
🪧 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 comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![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
🧹 Nitpick comments (1)
README.md (1)
34-35: Avoid introducing an isolated horizontal ruleThe README already follows a clear sectional hierarchy. Adding an extra
---here interrupts the visual flow without adding real value. Consider dropping the rule or relocating it to match the style used elsewhere in the document.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
⏰ 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: Summary
| ## 🚀 Getting Started (Local Setup) | ||
|
|
||
| To run this project locally, follow these steps: | ||
|
|
||
| ### 🧰 Prerequisites | ||
|
|
||
| - Python 3.8+ | ||
| - Node.js & Yarn | ||
| - Frappe Framework | ||
| - Redis, MariaDB, Node.js, and other Frappe dependencies | ||
|
|
||
| ### 🔽 1. Clone the Repository | ||
|
|
||
| ```bash | ||
| git clone https://github.com/Umeshinduranga/hrms.git | ||
| cd hrms | ||
|
|
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
New “Getting Started” block duplicates partial content and needs clean-up
- Content overlap – A complete local setup guide already exists under “Development setup → Local”. Maintaining two divergent instructions quickly gets outdated and confuses newcomers.
- Incomplete steps – The section stops after cloning; prerequisites such as
bench init, environment variables, site creation, or Docker are missing. - Wrong clone URL – Use the canonical repository (
frappe/hrms) rather than the author’s fork so copy-pasting always works. - Redundant bullet – “Node.js” is listed twice (with and without Yarn).
- Version specifics – Frappe Framework and Python versions should be pinned (
Frappe v15+,Python 3.10+, etc.) to avoid mismatch errors.
A concise fix could be either to (a) delete this block and point readers to the existing “Development setup”, or (b) fully flesh it out and remove the older section.
Example minimal patch if you keep the block:
-### 🧰 Prerequisites
-
-- Python 3.8+
-- Node.js & Yarn
-- Frappe Framework
-- Redis, MariaDB, Node.js, and other Frappe dependencies
+### 🧰 Prerequisites
+
+- Python 3.10 or higher
+- Node.js (v18 LTS) & Yarn
+- Frappe Framework (v15+)
+- Redis, MariaDB, and other Frappe dependencies
```bash
-git clone https://github.com/Umeshinduranga/hrms.git
+git clone https://github.com/frappe/hrms.git
cd hrms
Then continue with `bench init`, site creation, etc., or simply refer to the “Development setup” section to keep docs DRY.
---
🏁 Script executed:
```shell
#!/bin/bash
# Display the first 200 lines of README.md with line numbers
sed -n '1,200p' README.md | nl -ba
echo "-----"
# Find any 'Development setup' occurrences
grep -R "Development setup" -n README.md
Length of output: 213
Remove or Consolidate Duplicate “Getting Started” Section
The new block in README.md (lines 36–52) repeats the later Development setup section (line 97). To keep docs DRY and up-to-date:
• Location: README.md (lines 36–52) – the "🚀 Getting Started (Local Setup)" block.
• Option A: Delete this entire block and add a pointer to Development setup → Local.
• Option B: Fully flesh out the block and drop the older section:
– Prerequisites (pin versions):
• Python 3.10+
• Node.js 18 LTS & Yarn
• Frappe v15+
• Redis, MariaDB
– Update clone URL:
bash git clone https://github.com/frappe/hrms.git cd hrms
– Add missing steps (bench init, environment variables, site creation), or refer readers to the detailed “Development setup” section.
• Remove the redundant “Node.js” bullet and ensure version specifics are accurate.
🤖 Prompt for AI Agents
In README.md between lines 36 and 52, the "Getting Started (Local Setup)"
section duplicates content found later in the "Development setup" section around
line 97. To fix this, either delete the entire "Getting Started" block and
replace it with a clear pointer directing readers to the "Development setup →
Local" section, or fully expand the "Getting Started" block with accurate
prerequisites including pinned versions (Python 3.10+, Node.js 18 LTS & Yarn,
Frappe v15+, Redis, MariaDB), update the clone URL to
https://github.com/frappe/hrms.git, add missing setup steps like bench
initialization, environment variables, and site creation, and then remove the
older redundant section to avoid duplication.
Summary by CodeRabbit