You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@fineract.apache.org by "tiagosune (via GitHub)" <gi...@apache.org> on 2026/03/25 19:04:38 UTC
[PR] Add Quick Start section to improve onboarding [fineract]
tiagosune opened a new pull request, #5694:
URL: https://github.com/apache/fineract/pull/5694
This PR introduces a "Quick Start" section to improve the onboarding experience for new contributors.
It provides a simplified and structured guide to set up and run Apache Fineract locally, based on existing instructions in the README.
This section offers a quick overview of the setup process, while detailed instructions remain available below.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2555: Add Quick Start section to improve onboarding [fineract]
Posted by "tiagosune (via GitHub)" <gi...@apache.org>.
tiagosune commented on code in PR #5694:
URL: https://github.com/apache/fineract/pull/5694#discussion_r2997192301
##########
README.md:
##########
@@ -50,6 +50,39 @@ INSTRUCTIONS
The following how-to's assume you have Java installed, you cloned the repository (or downloaded and extracted a [specific version](https://github.com/apache/fineract/releases)) and you have a [database server](#database-and-tables) (MariaDB or PostgreSQL) running.
+Quick Start
+---
+
+This section provides a simplified overview of the setup process. More detailed instructions are available below.
+
+Follow these steps to quickly set up and run Apache Fineract locally:
+
+### Prerequisites
+- Java 21 or higher
+- PostgreSQL or MariaDB running locally
Review Comment:
Thank you for the feedback!
Since this PR has already been merged, I will create a new JIRA ticket and submit a follow-up PR to update the Quick Start documentation to focus on PostgreSQL as suggested.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2555: Add Quick Start section to improve onboarding [fineract]
Posted by "adamsaghy (via GitHub)" <gi...@apache.org>.
adamsaghy merged PR #5694:
URL: https://github.com/apache/fineract/pull/5694
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2555: Add Quick Start section to improve onboarding [fineract]
Posted by "tiagosune (via GitHub)" <gi...@apache.org>.
tiagosune commented on code in PR #5694:
URL: https://github.com/apache/fineract/pull/5694#discussion_r2997704854
##########
README.md:
##########
@@ -50,6 +50,39 @@ INSTRUCTIONS
The following how-to's assume you have Java installed, you cloned the repository (or downloaded and extracted a [specific version](https://github.com/apache/fineract/releases)) and you have a [database server](#database-and-tables) (MariaDB or PostgreSQL) running.
+Quick Start
+---
+
+This section provides a simplified overview of the setup process. More detailed instructions are available below.
+
+Follow these steps to quickly set up and run Apache Fineract locally:
+
+### Prerequisites
+- Java 21 or higher
+- PostgreSQL or MariaDB running locally
Review Comment:
> The instructions as written (e.g. `createDB` below) will only work with MariaDB or MySQL, but since [FSIP-9](https://cwiki.apache.org/confluence/display/FINERACT/FSIP-9%3A+Standardize+on+PostgreSQL) has been accepted we should focus on PostgreSQL only.
Following up on the previous feedback regarding PostgreSQL support, I created a new PR to update the Quick Start section accordingly:
https://github.com/apache/fineract/pull/5701
Please let me know if this aligns with the expected approach or if any adjustments are needed.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add Quick Start section to improve onboarding [fineract]
Posted by "San-43 (via GitHub)" <gi...@apache.org>.
San-43 commented on PR #5694:
URL: https://github.com/apache/fineract/pull/5694#issuecomment-4129461216
Hello @tiagosune you must sign your commits see -> [CONTRIBUTION.md](https://github.com/apache/fineract/blob/develop/CONTRIBUTING.md)
Also: please follow the rules for pull request title format: "FINERACT-1234: Your title here"...
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2555: Add Quick Start section to improve onboarding [fineract]
Posted by "meonkeys (via GitHub)" <gi...@apache.org>.
meonkeys commented on code in PR #5694:
URL: https://github.com/apache/fineract/pull/5694#discussion_r2996829460
##########
README.md:
##########
@@ -50,6 +50,39 @@ INSTRUCTIONS
The following how-to's assume you have Java installed, you cloned the repository (or downloaded and extracted a [specific version](https://github.com/apache/fineract/releases)) and you have a [database server](#database-and-tables) (MariaDB or PostgreSQL) running.
+Quick Start
+---
+
+This section provides a simplified overview of the setup process. More detailed instructions are available below.
+
+Follow these steps to quickly set up and run Apache Fineract locally:
+
+### Prerequisites
+- Java 21 or higher
+- PostgreSQL or MariaDB running locally
Review Comment:
The instructions as written (e.g. `createDB` below) will only work with MariaDB or MySQL, but since [FSIP-9](https://cwiki.apache.org/confluence/display/FINERACT/FSIP-9%3A+Standardize+on+PostgreSQL) has been accepted we should focus on PostgreSQL only.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add Quick Start section to improve onboarding [fineract]
Posted by "tiagosune (via GitHub)" <gi...@apache.org>.
tiagosune commented on PR #5694:
URL: https://github.com/apache/fineract/pull/5694#issuecomment-4130134703
> Hello @tiagosune you must sign your commits see -> [CONTRIBUTING.md](https://github.com/apache/fineract/blob/develop/CONTRIBUTING.md)
>
> Also: please follow the rules for pull request title format: "[FINERACT-1234](https://issues.apache.org/jira/browse/FINERACT-1234): Your title here"...
Hi, thank you for the feedback!
I have now signed my commits using GPG and updated the commit message to follow the required format (FINERACT-2555).
Please let me know if anything else needs to be adjusted.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org