FINERACT-2555: Add Quick Start section to improve onboarding#5694
FINERACT-2555: Add Quick Start section to improve onboarding#5694adamsaghy merged 1 commit intoapache:developfrom
Conversation
|
Hello @tiagosune you must sign your commits see -> CONTRIBUTING.md Also: please follow the rules for pull request title format: "FINERACT-1234: Your title here"... |
tiagosune
force-pushed
the
improve-readme-quickstart
branch
2 times, most recently
from
0543399 to
8308c03
Compare
tiagosune
force-pushed
the
improve-readme-quickstart
branch
from
8308c03 to
6efe21b
Compare
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. |
tiagosune
changed the title
|
|
||
| ### Prerequisites | ||
| - Java 21 or higher | ||
| - PostgreSQL or MariaDB running locally |
There was a problem hiding this comment.
The instructions as written (e.g. createDB below) will only work with MariaDB or MySQL, but since FSIP-9 has been accepted we should focus on PostgreSQL only.
There was a problem hiding this 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.
There was a problem hiding this comment.
The instructions as written (e.g.
createDBbelow) will only work with MariaDB or MySQL, but since FSIP-9 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:
Please let me know if this aligns with the expected approach or if any adjustments are needed.
4 participants
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.