docs: add Node.js version requirement, prerequisites table and troubleshooting guide#3437
docs: add Node.js version requirement, prerequisites table and troubleshooting guide#3437Rupsapatra3107 wants to merge 1 commit intoopenMF:devfrom
Conversation
Updated the installation guide to include a table format for prerequisites and added important notes regarding Node.js compatibility.
|
Note
|
| Cohort / File(s) | Summary |
|---|---|
Documentation README.md |
Converted prerequisites bullet list to structured table with specific version requirements; added Node.js v20+ incompatibility warning and version check command. |
Estimated code review effort
🎯 1 (Trivial) | ⏱️ ~3 minutes
🚥 Pre-merge checks | ✅ 3
✅ 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 accurately describes the main documentation changes: adding Node.js version requirements, a prerequisites table, and a troubleshooting guide, all of which are confirmed in the raw summary and PR objectives. |
| Docstring Coverage | ✅ Passed | No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. |
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
✨ Finishing Touches
🧪 Generate unit tests (beta)
- Create PR with 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.
Comment @coderabbitai help to get the list of available commands and usage tips.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 36: Remove the stray empty fenced code block from the README: locate the
isolated triple backticks (```) that open and immediately close a code fence
with no content (the empty code fence) and delete them so the README no longer
contains an empty code block.
- Around line 24-36: The PR claims a new "Troubleshooting" section was added but
README.md lacks it; add a "Troubleshooting" heading and content beneath the
existing sections (e.g., after "Prerequisites for All Methods" or before
"Default Login Credentials") that lists common setup issues and solutions such
as Node.js version mismatch (v16/v18 required, v20 incompatible), Angular CLI
install errors, npm permission issues, proxy configuration tips, and steps to
verify services (e.g., Mifos® X/Apache Fineract running); ensure the heading is
exactly "Troubleshooting" and the entries reference the commands shown elsewhere
(like node -v) and provide concise remediation steps so the PR description
matches the README changes.
| ## Prerequisites for All Methods | ||
|
|
||
| | Tool | Required Version | Download | | ||
| |------|-----------------|----------| | ||
| | Git | Latest | [Download here](https://git-scm.com/downloads) | | ||
| | Node.js | 16.x or 18.x ⚠️ | [Download here](https://nodejs.org/en/download) | | ||
| | Angular CLI | 16.0.2 | Installed via npm (see below) | | ||
| | Mifos® X Backend (Apache Fineract®) | Latest | Required before running the web app | | ||
|
|
||
| > ⚠️ **Important:** Angular CLI 16.0.2 requires **Node.js v16.x or v18.x**. | ||
| > Node.js v20+ is **not compatible** and will cause installation errors. | ||
| > To check your Node.js version, run: `node -v` | ||
| ``` |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Search for Troubleshooting section in README.md
rg -i "troubleshoot" README.md -C 3Repository: openMF/web-app
Length of output: 486
🏁 Script executed:
#!/bin/bash
# Search for markdown section headers containing "Troubleshoot"
echo "=== Searching for Troubleshooting section headers ==="
rg "^#+\s+.*[Tt]roubleshoot" README.md
echo -e "\n=== All top-level section headers in README ==="
rg "^##\s+[^#]" README.mdRepository: openMF/web-app
Length of output: 418
Add the missing Troubleshooting section to README.md.
The PR objectives state: "Added a Troubleshooting section covering common setup issues," but this section does not exist in the README. The search found only these sections: Overview, Quick Links, Installation Guide, Prerequisites for All Methods, Default Login Credentials, Development Commands, Proxy Configuration, Configuration Options, Interbank Transfer Menu, Releases, Contributing, and Related Projects. Either implement the Troubleshooting section or update the PR description to reflect the actual changes made.
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 36-36: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 24 - 36, The PR claims a new "Troubleshooting"
section was added but README.md lacks it; add a "Troubleshooting" heading and
content beneath the existing sections (e.g., after "Prerequisites for All
Methods" or before "Default Login Credentials") that lists common setup issues
and solutions such as Node.js version mismatch (v16/v18 required, v20
incompatible), Angular CLI install errors, npm permission issues, proxy
configuration tips, and steps to verify services (e.g., Mifos® X/Apache Fineract
running); ensure the heading is exactly "Troubleshooting" and the entries
reference the commands shown elsewhere (like node -v) and provide concise
remediation steps so the PR description matches the README changes.
| > ⚠️ **Important:** Angular CLI 16.0.2 requires **Node.js v16.x or v18.x**. | ||
| > Node.js v20+ is **not compatible** and will cause installation errors. | ||
| > To check your Node.js version, run: `node -v` | ||
| ``` |
There was a problem hiding this comment.
Remove the empty code fence.
Line 36 contains an empty fenced code block that serves no purpose. This appears to be an editing error and should be removed.
🧹 Proposed fix
> To check your Node.js version, run: `node -v`
-```📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ``` | |
| > To check your Node.js version, run: `node -v` |
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 36-36: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 36, Remove the stray empty fenced code block from the
README: locate the isolated triple backticks (```) that open and immediately
close a code fence with no content (the empty code fence) and delete them so the
README no longer contains an empty code block.
IOhacker
left a comment
IOhacker
left a comment
There was a problem hiding this comment.
Review the version of NodeJS used
2 participants
What this PR does
Why
The current README does not specify the required Node.js version, which causes
confusion for new contributors. This update helps beginners set up the project
without hitting common errors.
Type of change
Summary by CodeRabbit