Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix: readme, guides and docker compose files #91

Merged
merged 20 commits into from
May 10, 2023
Merged

Fix: readme, guides and docker compose files #91

merged 20 commits into from
May 10, 2023

Conversation

RMCampos
Copy link
Contributor

@RMCampos RMCampos commented May 9, 2023 •
edited by github-actions bot
Loading

Description

  • Updates README files
  • Updates CONTRIBUTING files
  • Creates docker compose files for each service

Fixes Jira Task 666 and #37

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)

How Has This Been Tested?

These changes were tested locally with Docker.

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!

Any successful deployments (not always required) will be available below.
Backend
Frontend
Oracle-API

Once merged, code will be promoted and handed off to following workflow run.
Main Merge Workflow

@RMCampos RMCampos self-assigned this May 9, 2023
@RMCampos
Copy link
Contributor Author

RMCampos commented May 9, 2023

@DerekRoberts and @craigyu some of these files were added on PR #62 but for some reason they were lost. I'm adding those again, and including some docker-compose files.

@DerekRoberts please feel free to update and review docker-compose files.

DerekRoberts
DerekRoberts requested changes May 9, 2023
View reviewed changes
Copy link
Member

@DerekRoberts DerekRoberts left a comment

Choose a reason for hiding this comment

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

Great progress! Please use only one docker-compose.yml in the repo root. The rest should be deleted.

@RMCampos
Copy link
Contributor Author

RMCampos commented May 9, 2023

Great progress! Please use only one docker-compose.yml in the repo root. The rest should be deleted.

Maybe we could have two. One with all four services, and another one with backend only (database plus two api). What do you think? @DerekRoberts

@DerekRoberts
Copy link
Member

Great progress! Please use only one docker-compose.yml in the repo root. The rest should be deleted.

Maybe we could have two. One with all four services, and another one with backend only (database plus two api). What do you think? @DerekRoberts

That means maintaining two compose files. Please stick with one stack and let everyone get exposed to the same workflow. If resources are an issue we can revisit.

@craigyu
Copy link
Collaborator

craigyu commented May 9, 2023

Great progress! Please use only one docker-compose.yml in the repo root. The rest should be deleted.

Maybe we could have two. One with all four services, and another one with backend only (database plus two api). What do you think? @DerekRoberts

I think we can specify which service to run like this https://stackoverflow.com/a/52021291
Will that be the solution?

We are planning to have DB running in docker as well, but that should be in another PR.

@RMCampos
Copy link
Contributor Author

RMCampos commented May 9, 2023

docker as well, but that should be in another

I'm thinking for frontend development. We'll need all backend services running. But the frontend will run locally, not in docker. If we can specify which one we want, that works I think.

@DerekRoberts
Copy link
Member

DerekRoberts commented May 9, 2023 •
edited
Loading

@RMCampos We have control over what's started started by Docker Compose, but I want people seeing the whole stack.

E.g. docker-compose up -d <COMPONENT>

@DerekRoberts
Copy link
Member

DerekRoberts commented May 9, 2023 •
edited
Loading

@craigyu @RMCampos Db should be included. If not, let's get that fixed!

@DerekRoberts DerekRoberts force-pushed the fix/docs-and-docker-compose-files branch from 9126ea8 to 8a062c3 Compare May 9, 2023 17:30
@DerekRoberts DerekRoberts reopened this May 9, 2023
@RMCampos RMCampos requested a review from DerekRoberts May 9, 2023 18:13
@RMCampos RMCampos changed the title Fix/docs and docker compose files Fix: readme, guides and docker compose files May 9, 2023
@craigyu craigyu merged commit 2a5febf into main May 10, 2023
@craigyu craigyu deleted the fix/docs-and-docker-compose-files branch May 10, 2023 00:44
DerekRoberts added a commit that referenced this pull request May 13, 2024
@craigyu @DerekRoberts
Fix: readme, guides and docker compose files (#91)
20eb62d 
* docs: add docker compose files for backend and database

* docs: add reame and contributing files, docker compose and maven config

* feat: add optional port from env var for oracle-api docker healtcheck

* fix: wrong oracle driver class name causing warnings

* docs: update oracle-api readme to include docker running instructions

* feat: update oracle-api to use proper healthcheck from actuator

* docs: add docker compose files for backend and database

* docs: add reame and contributing files, docker compose and maven config

* feat: update to use only one docker-compose file

* feat: removed unused files and fixed readme

* chore: remove unused docker compose file

* fix: remove clipboard feature from react-serve in frontend

* fix: upgrade eclipse-temruin for oracle-api dockerfile

* Swap curl for wget

* fix: add pyhton3 to Dockerfile so it builds on machines with Apple chips

* fix: update allowed cors origins rule in oracle and postgres server

* fix: remove access control allow origin rule in frontend

* fix: attempt to make backend wait for db to be ready to accept connection

---------

Co-authored-by: Craig Yu <craig.yu93@gmail.com>
Co-authored-by: Derek Roberts <derek.roberts@gmail.com>
DerekRoberts added a commit that referenced this pull request May 14, 2024
@craigyu @DerekRoberts
Fix: readme, guides and docker compose files (#91)
a6e40fa 
* docs: add docker compose files for backend and database

* docs: add reame and contributing files, docker compose and maven config

* feat: add optional port from env var for oracle-api docker healtcheck

* fix: wrong oracle driver class name causing warnings

* docs: update oracle-api readme to include docker running instructions

* feat: update oracle-api to use proper healthcheck from actuator

* docs: add docker compose files for backend and database

* docs: add reame and contributing files, docker compose and maven config

* feat: update to use only one docker-compose file

* feat: removed unused files and fixed readme

* chore: remove unused docker compose file

* fix: remove clipboard feature from react-serve in frontend

* fix: upgrade eclipse-temruin for oracle-api dockerfile

* Swap curl for wget

* fix: add pyhton3 to Dockerfile so it builds on machines with Apple chips

* fix: update allowed cors origins rule in oracle and postgres server

* fix: remove access control allow origin rule in frontend

* fix: attempt to make backend wait for db to be ready to accept connection

---------

Co-authored-by: Craig Yu <craig.yu93@gmail.com>
Co-authored-by: Derek Roberts <derek.roberts@gmail.com>
DerekRoberts added a commit that referenced this pull request May 14, 2024
@craigyu @DerekRoberts
Fix: readme, guides and docker compose files (#91)
ead7a19 
* docs: add docker compose files for backend and database

* docs: add reame and contributing files, docker compose and maven config

* feat: add optional port from env var for oracle-api docker healtcheck

* fix: wrong oracle driver class name causing warnings

* docs: update oracle-api readme to include docker running instructions

* feat: update oracle-api to use proper healthcheck from actuator

* docs: add docker compose files for backend and database

* docs: add reame and contributing files, docker compose and maven config

* feat: update to use only one docker-compose file

* feat: removed unused files and fixed readme

* chore: remove unused docker compose file

* fix: remove clipboard feature from react-serve in frontend

* fix: upgrade eclipse-temruin for oracle-api dockerfile

* Swap curl for wget

* fix: add pyhton3 to Dockerfile so it builds on machines with Apple chips

* fix: update allowed cors origins rule in oracle and postgres server

* fix: remove access control allow origin rule in frontend

* fix: attempt to make backend wait for db to be ready to accept connection

---------

Co-authored-by: Craig Yu <craig.yu93@gmail.com>
Co-authored-by: Derek Roberts <derek.roberts@gmail.com>
DerekRoberts added a commit that referenced this pull request May 14, 2024
@craigyu @DerekRoberts
Fix: readme, guides and docker compose files (#91)
5dcb3aa 
* docs: add docker compose files for backend and database

* docs: add reame and contributing files, docker compose and maven config

* feat: add optional port from env var for oracle-api docker healtcheck

* fix: wrong oracle driver class name causing warnings

* docs: update oracle-api readme to include docker running instructions

* feat: update oracle-api to use proper healthcheck from actuator

* docs: add docker compose files for backend and database

* docs: add reame and contributing files, docker compose and maven config

* feat: update to use only one docker-compose file

* feat: removed unused files and fixed readme

* chore: remove unused docker compose file

* fix: remove clipboard feature from react-serve in frontend

* fix: upgrade eclipse-temruin for oracle-api dockerfile

* Swap curl for wget

* fix: add pyhton3 to Dockerfile so it builds on machines with Apple chips

* fix: update allowed cors origins rule in oracle and postgres server

* fix: remove access control allow origin rule in frontend

* fix: attempt to make backend wait for db to be ready to accept connection

---------

Co-authored-by: Craig Yu <craig.yu93@gmail.com>
Co-authored-by: Derek Roberts <derek.roberts@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@craigyu craigyu craigyu approved these changes

@SLDonnelly SLDonnelly Awaiting requested review from SLDonnelly SLDonnelly is a code owner

@DerekRoberts DerekRoberts Awaiting requested review from DerekRoberts DerekRoberts is a code owner

Assignees

@RMCampos RMCampos

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@RMCampos @DerekRoberts @craigyu