Enhance README with Windows 11 Fineract setup instructions#3442
Enhance README with Windows 11 Fineract setup instructions#3442anandhinallaganti wants to merge 1 commit intoopenMF:devfrom
Conversation
Add detailed Windows 11 setup guide for local Fineract installation with troubleshooting tips.
|
Note
|
| Cohort / File(s) | Summary |
|---|---|
README Documentation Updates README.md |
Adjusted formatting for existing installation link; added detailed "Windows 11 — Step by step" subsection covering Java 21, MySQL 8, Git installation, database creation, configuration, backend startup via Gradle with HTTPS health verification, and frontend startup via ng serve; added "Troubleshooting (Windows)" section addressing Liquibase migration locks, community-app limitations, and Command Prompt usage for MySQL; appended "How to submit" section with PR submission steps and template for openMF/web-app. |
Estimated code review effort
🎯 2 (Simple) | ⏱️ ~12 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 'Enhance README with Windows 11 Fineract setup instructions' is specific and directly related to the main change, which adds comprehensive Windows 11 setup documentation for Apache Fineract. |
| 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
Warning
Review ran into problems
🔥 Problems
Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.
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: 1
🧹 Nitpick comments (2)
README.md (2)
101-126: Move PR submission workflow out of README and into contribution docs.This section is contributor-process guidance and will get stale in a user-facing setup README. Please move it to
.github/CONTRIBUTING.md(or a contributor guide) and keep README focused on environment setup/run instructions.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 101 - 126, The PR submission workflow content currently in README.md should be moved into a new contributor guide file (.github/CONTRIBUTING.md): extract the entire contributor-process section (the "PR submission workflow" heading and its steps) from README.md, create .github/CONTRIBUTING.md containing that content (adjust headings/formatting as needed), and replace the removed section in README.md with a short pointer/link to the new CONTRIBUTING.md to keep the README focused on setup/run instructions.
58-63: Prefer environment-variable instructions over editing password values in tracked config.To reduce accidental secret leakage and local config drift, document setting
FINERACT_HIKARI_PASSWORDandFINERACT_DEFAULT_TENANTDB_PWDin the shell/session instead of telling users to edit password values inapplication.properties.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 58 - 63, Update the README guidance to prefer setting secrets via environment variables instead of editing tracked config: replace instructions that tell users to edit application.properties password values with a short snippet and explanation that users should set FINERACT_HIKARI_PASSWORD and FINERACT_DEFAULT_TENANTDB_PWD in their shell/session (e.g., export or dotenv) and mention how the application reads these env vars at runtime; remove or comment out any example plaintext passwords in README/application.properties and add a brief note about not committing secrets.
🤖 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`:
- Around line 97-99: Remove the stray fenced code block marker (the unintended
triple backticks) that was left open after the Troubleshooting section so the
rest of the README renders correctly; locate the unintended "```" after the
Troubleshooting content and delete it (ensuring the section divider '---' and
following headings remain plain text), leaving only the intended markdown
structure.
---
Nitpick comments:
In `@README.md`:
- Around line 101-126: The PR submission workflow content currently in README.md
should be moved into a new contributor guide file (.github/CONTRIBUTING.md):
extract the entire contributor-process section (the "PR submission workflow"
heading and its steps) from README.md, create .github/CONTRIBUTING.md containing
that content (adjust headings/formatting as needed), and replace the removed
section in README.md with a short pointer/link to the new CONTRIBUTING.md to
keep the README focused on setup/run instructions.
- Around line 58-63: Update the README guidance to prefer setting secrets via
environment variables instead of editing tracked config: replace instructions
that tell users to edit application.properties password values with a short
snippet and explanation that users should set FINERACT_HIKARI_PASSWORD and
FINERACT_DEFAULT_TENANTDB_PWD in their shell/session (e.g., export or dotenv)
and mention how the application reads these env vars at runtime; remove or
comment out any example plaintext passwords in README/application.properties and
add a brief note about not committing secrets.
IOhacker
left a comment
IOhacker
left a comment
There was a problem hiding this comment.
This should be included in this readme. There are another repositories for that.
2 participants
Add detailed Windows 11 setup guide for local Fineract installation with troubleshooting tips.
Description
Describe the changes made and why they were made instead of how they were made. List any dependencies that are required for this change.
Related issues and discussion
#{Issue Number}
Screenshots, if any
Checklist
Please make sure these boxes are checked before submitting your pull request - thanks!
If you have multiple commits please combine them into one commit by squashing them.
Read and understood the contribution guidelines at
web-app/.github/CONTRIBUTING.md.Summary by CodeRabbit