Skip to content

FINERACT-2557: Update Quick Start to focus on PostgreSQL and remove MySQL-specific database commands#5701

Merged
meonkeys merged 1 commit intoapache:developfrom
tiagosune:update-readme-postgresql
Mar 31, 2026
Merged

FINERACT-2557: Update Quick Start to focus on PostgreSQL and remove MySQL-specific database commands#5701
meonkeys merged 1 commit intoapache:developfrom
tiagosune:update-readme-postgresql

Conversation

@tiagosune
Copy link
Copy Markdown
Contributor

@tiagosune tiagosune commented Mar 26, 2026

Description

FINERACT-2557

This PR updates the Quick Start section to align with FSIP-9 by focusing on PostgreSQL as the primary supported database.

The previous instructions included database creation commands that only work with MariaDB/MySQL (createDB). Since PostgreSQL is now the recommended database, those commands were removed to avoid confusion.

The Quick Start section now:

  • Assumes PostgreSQL is properly configured
  • References the detailed database setup section for further instructions

Additionally, this change keeps the Quick Start simple and avoids including commands that may not work out-of-the-box for PostgreSQL.

Please let me know if there's a preferred way to include PostgreSQL-specific setup instructions here.

Checklist

Please make sure these boxes are checked before submitting your pull request - thanks!

  • Write the commit message as per our guidelines
  • Acknowledge that we will not review PRs that are not passing the build ("green") - it is your responsibility to get a proposed PR to pass the build, not primarily the project's maintainers.
  • Create/update unit or integration tests for verifying the changes made.
  • Follow our coding conventions.
  • Add required Swagger annotation and update API documentation at fineract-provider/src/main/resources/static/legacy-docs/apiLive.htm with details of any API changes
  • This PR must not be a "code dump". Large changes can be made in a branch, with assistance. Ask for help on the developer mailing list.

Your assigned reviewer(s) will follow our guidelines for code reviews.

@tiagosune
Copy link
Copy Markdown
Contributor Author

Following up on the previous feedback, this PR updates the Quick Start section to focus on PostgreSQL and removes database creation commands that were specific to MariaDB/MySQL.

Let me know if we should include PostgreSQL-specific setup commands here once the recommended approach is clarified.

@meonkeys
Copy link
Copy Markdown
Contributor

ping

@tiagosune
Copy link
Copy Markdown
Contributor Author

ping

Thanks for the ping!

I’m currently updating the PR to use the createPGDB task as suggested and testing it locally. I’ll push the changes shortly.

@tiagosune tiagosune force-pushed the update-readme-postgresql branch from 244afac to c8ebab3 Compare March 30, 2026 17:41
@tiagosune
Copy link
Copy Markdown
Contributor Author

I updated the Quick Start section to use the createPGDB task as suggested.

I also tested it locally and confirmed that it works when PostgreSQL is properly configured. In particular:

  • the PostgreSQL user and password must be set (e.g. root/postgres as used in CI)
  • an initial database (e.g. "root") must exist for the connection

I added a note in the documentation to clarify these requirements and updated the commit accordingly.

Please let me know if you'd like me to simplify or expand the setup instructions further.

@tiagosune tiagosune requested a review from meonkeys March 30, 2026 19:38
@tiagosune tiagosune force-pushed the update-readme-postgresql branch from c8ebab3 to 5800ba0 Compare March 31, 2026 01:14
@meonkeys
Copy link
Copy Markdown
Contributor

meonkeys commented Mar 31, 2026

Will you please rebase your branch on top of develop (and force push again) before I merge this? It's been quite a few merges since this PR started, so it'll be must cleaner to merge if you rebase first.

Copy link
Copy Markdown
Contributor

@meonkeys meonkeys left a comment

Choose a reason for hiding this comment

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

please rebase on develop latest (b26571b as of right now, and it probably won't move in the next few hours)

@tiagosune tiagosune force-pushed the update-readme-postgresql branch from 5800ba0 to c71966c Compare March 31, 2026 02:30
@tiagosune
Copy link
Copy Markdown
Contributor Author

please rebase on develop latest (b26571b as of right now, and it probably won't move in the next few hours)

Done! I’ve rebased the branch on top of the latest develop and force-pushed the changes.

Please let me know if everything looks good now.

@meonkeys meonkeys merged commit a357323 into apache:develop Mar 31, 2026
43 checks passed
@tiagosune tiagosune deleted the update-readme-postgresql branch March 31, 2026 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants