Skip to content

docs: add Node.js version requirement, prerequisites table and troubleshooting guide #3437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Rupsapatra3107 wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

docs: add Node.js version requirement, prerequisites table and troubleshooting guide #3437

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,19 @@ Mifos® X Web App is a modern single-page application (SPA) built on top of the

## Installation Guide

### Prerequisites for All Methods

- Git: [Download here](https://git-scm.com/downloads)
- Mifos® X Backend (Apache Fineract®) - **Required before running the web app**

## 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`
```
Comment on lines +24 to +36
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Search for Troubleshooting section in README.md

rg -i "troubleshoot" README.md -C 3

Repository: 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.md

Repository: 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.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

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.

Suggested change
```
> 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.

### Backend Setup (REQUIRED FIRST)

Before installing the web app, you need to set up the Apache Fineract® backend server:
Expand Down