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

Add debug docker config to work with vscode debugging extension #32

Merged
merged 10 commits into from
Feb 12, 2025

Conversation

Adamkadaban
Copy link
Member

@Adamkadaban Adamkadaban commented Feb 12, 2025

Checklist

  • I have added a version label to my PR (e.g., patch, minor, major).
  • I have tested my changes locally and verified they work as expected.
  • I have added relevant tests to cover my changes.
  • I have made any necessary updates to the documentation.

Description

  • Add debug docker-compose and dockerfile
  • Allow .vscode/launch.json for debugging to be committed
  • Add documentation section to readme
  • Clarify server name for .env in docs
  • Use docker compose instead of docker-compose in README

Fixes: #28

@Adamkadaban Adamkadaban added the documentation Changes only affect the documentation label Feb 12, 2025
Copy link
Member

@alexchristy alexchristy left a comment

Choose a reason for hiding this comment

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

I probably missed it, but for code changes and auto reload to work in the debug container don't we need a volume for the fastapi container?

@Adamkadaban
Copy link
Member Author

I probably missed it, but for code changes and auto reload to work in the debug container don't we need a volume for the fastapi container?

@alexchristy Isn't that in the docker-compose.dev.yml file? Auto-reload works for me
https://github.com/OpenLabsX/API/pull/32/files#diff-9542f82d64bbeebd91f6236324bfe199e9657e2cb1fd9779d5d6dcdcf9cd4de1R26

@alexchristy
Copy link
Member

I probably missed it, but for code changes and auto reload to work in the debug container don't we need a volume for the fastapi container?

@alexchristy Isn't that in the docker-compose.dev.yml file? Auto-reload works for me https://github.com/OpenLabsX/API/pull/32/files#diff-9542f82d64bbeebd91f6236324bfe199e9657e2cb1fd9779d5d6dcdcf9cd4de1R26

Oh yea there it is. For some reason I looked over it several times and missed it 🫠

Copy link
Member

@alexchristy alexchristy left a comment

Choose a reason for hiding this comment

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

Everything is looking good!

Copy link
Member

@Nareshp1 Nareshp1 left a comment

Choose a reason for hiding this comment

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

LGTM

@Adamkadaban Adamkadaban merged commit 20cc54a into main Feb 12, 2025
3 checks passed
@Adamkadaban Adamkadaban deleted the adam-docker-vscode-debug branch February 17, 2025 04:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes only affect the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Docker Debug config
3 participants