Skip to content

docs(#1163): add backend README with setup instructions#1179

Merged
Abradat merged 6 commits intomainfrom
doc/1163-document-backend-refactoring-and-new-architecture
Feb 10, 2026
Merged

docs(#1163): add backend README with setup instructions#1179
Abradat merged 6 commits intomainfrom
doc/1163-document-backend-refactoring-and-new-architecture

Conversation

@Abradat
Copy link
Collaborator

@Abradat Abradat commented Feb 9, 2026

Description

This pull request adds a new README.md file to the backend directory, 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:

  • Added a comprehensive backend/README.md with setup instructions, environment variable guidance, database configuration details, Flyway migration information, and testing commands for Oracle and PostgreSQL.

Documents #1163

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Documentation update

How Has This Been Tested?

  • New unit tests
  • New integrated tests
  • New component tests
  • New end-to-end tests
  • New user flow tests
  • No new tests are required
  • Manual tests (description below)
  • Updated existing tests

Checklist

  • I have read the CONTRIBUTING doc
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have already been accepted and merged

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:

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.
@Abradat Abradat linked an issue Feb 9, 2026 that may be closed by this pull request
@Abradat Abradat marked this pull request as ready for review February 9, 2026 22:57
Copilot AI review requested due to automatic review settings February 9, 2026 22:57
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.md with prerequisites and run instructions.
  • Documents PRIMARY_DB / FLYWAY_ENVIRONMENT usage 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.

Abradat and others added 3 commits February 9, 2026 16:40
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>
Copy link
Collaborator

@craigyu craigyu left a comment

Choose a reason for hiding this comment

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

good guide, should we mention how to populate the local postgres db using the tools under ora2pg/tools?

@Abradat
Copy link
Collaborator Author

Abradat commented Feb 10, 2026

@craigyu Do you think it's better to provide instructions to load the data from ora2pg/tools or to add a reference to the folder, as it has its own documentation?

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.
Copy link
Collaborator

@craigyu craigyu left a comment

Choose a reason for hiding this comment

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

👍

@Abradat Abradat merged commit 50c542f into main Feb 10, 2026
25 checks passed
@Abradat Abradat deleted the doc/1163-document-backend-refactoring-and-new-architecture branch February 10, 2026 23:57
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.

[DOCS]: Document Backend Refactoring and New Architecture

3 participants