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.

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

Improve README and docker compose files #43

Merged
merged 7 commits into from
Sep 29, 2024
Merged

Improve README and docker compose files #43

merged 7 commits into from
Sep 29, 2024

Conversation

samuelim01
Copy link

Description

  • Wrote a simple README.md for development start up.
  • Separated the compose file into base and development versions. This helps prevent issues with empty node_modules/ folders that may arise when mounted for hot reloading in development environments.

Checklist

  • I have updated documentation
  • All tests passing

Screenshots (if applicable)

* Split `docker-compose.yml` into `compose.yml` and `compose.dev.yml`
* Ensure all containers restart
* Unmount volumes for base `compose.yml`
* Publish backend service ports only for `compose.dev.yml`
* Configure backend services to have both "start" and "dev" scripts
@samuelim01 samuelim01 added this to the Milestone 2 milestone Sep 28, 2024
@samuelim01 samuelim01 self-assigned this Sep 28, 2024
@samuelim01 samuelim01 added documentation Improvements or additions to documentation devops labels Sep 28, 2024
README.md Outdated Show resolved Hide resolved
@limcaaarl
Copy link

I tried following the steps in the README, but for some reason I cannot fetch data from question service even though it's up and running.

image

image

@limcaaarl
Copy link

I tried following the steps in the README, but for some reason I cannot fetch data from question service even though it's up and running.

Just tested using docker compose -f compose.yml -f compose.dev.yml up -d instead of docker compose -f compose.yml up -d and it works perfectly fine now.

* Ensure backend services can communicate
* Remove useless networks
* Due to the lack of API gateway, all backend services currently need to be exposed directly for now.
@samuelim01
Copy link
Author

samuelim01 commented Sep 28, 2024

I tried following the steps in the README, but for some reason I cannot fetch data from question service even though it's up and running.

Just tested using docker compose -f compose.yml -f compose.dev.yml up -d instead of docker compose -f compose.yml up -d and it works perfectly fine now.

good catch, there was a very glaring error in the docker compose file 😞 currently all backend services needs their ports exposed because the frontend client makes calls directly from the user's browser instead of through the frontend server.

Copy link

@limcaaarl limcaaarl left a comment

Choose a reason for hiding this comment

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

LGTM!

@samuelim01 samuelim01 merged commit f906bf1 into main Sep 29, 2024
2 checks passed
@samuelim01 samuelim01 deleted the improve-docker branch September 29, 2024 03:44
KhoonSun47 added a commit to KhoonSun47/cs3219-ay2425s1-project-g03 that referenced this pull request Sep 29, 2024
* main:
  Improve README and docker compose files (CS3219-AY2425S1#43)
  Update README and questionController.ts (CS3219-AY2425S1#42)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops documentation Improvements or additions to documentation priority.High
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants