docs(#1163): add backend README with setup instructions#1179
Merged
Conversation
Add backend/README.md documenting how to run and configure the backend service. Includes prerequisites (Java 17, Maven), required databases (Oracle and PostgreSQL), environment variables (PRIMARY_DB, FLYWAY_ENVIRONMENT), examples for running with Oracle/Postgres, Maven wrapper run command, application.yml primary-db setting, Flyway migration locations (dev vs prod), and test commands for both databases.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds initial backend-specific documentation to help developers configure and run the Spring Boot service against Oracle and/or PostgreSQL, including Flyway and test commands.
Changes:
- Introduces
backend/README.mdwith prerequisites and run instructions. - Documents
PRIMARY_DB/FLYWAY_ENVIRONMENTusage and Flyway migration locations. - Adds Maven commands for running backend tests under Oracle vs PostgreSQL modes.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
craigyu
reviewed
Feb 10, 2026
Collaborator
craigyu
left a comment
There was a problem hiding this comment.
good guide, should we mention how to populate the local postgres db using the tools under ora2pg/tools?
Collaborator
Author
|
@craigyu Do you think it's better to provide instructions to load the data from |
Add a section to backend/README.md explaining how to load test data into a local PostgreSQL environment. The new text points to ora2pg/tools/README.md for detailed instructions on combining migration files and importing them into the database, making it easier for developers to populate local dev databases for testing.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request adds a new
README.mdfile to thebackenddirectory, providing clear instructions for setting up, configuring, and running the backend service with both Oracle and PostgreSQL databases. The documentation covers prerequisites, environment variables, database configuration, Flyway migrations, and testing procedures.Documentation improvements:
backend/README.mdwith setup instructions, environment variable guidance, database configuration details, Flyway migration information, and testing commands for Oracle and PostgreSQL.Documents #1163
Type of change
How Has This Been Tested?
Checklist
Further comments
Thanks for the PR!
Deployments, as required, will be available below:
Please create PRs in draft mode. Mark as ready to enable:
After merge, new images are deployed in: