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 docker compose #28

Open
jenniferjiangkells opened this issue Jun 6, 2024 · 8 comments
Open

Add docker compose #28

jenniferjiangkells opened this issue Jun 6, 2024 · 8 comments
Labels
Component: Sandbox Issue/PRs that deal with the client and server components of the sandbox hacktoberfest Issues suitable for hacktoberfest Issue: Feature Request ✨ New feature or improvement to existing feature

Comments

@jenniferjiangkells
Copy link
Member

jenniferjiangkells commented Jun 6, 2024

Description

Add support to run the sandbox application in a Docker environment

Context

Adding docker-compose.yml will help developers quickly set up their environments and ensure consistency across different machines. It will also make it easier to manage dependencies and services required for the application and reduce "it works on my machine" type issues.

decorators.py/sandbox

Possible Implementation

  • Create a Dockerfile file
  • Create a docker-compose.yml, which
    • runs sandbox service
    • mounts a volume for output data
  • Create a run_sandbox.py script as an entrypoint (see example_use.py)
  • Update instructions in the README on usage

Some adjustments to the start_sandbox function may also be needed. Possible changes:

  • Get the service and host configs from environment variable instead of self.service_config
  • Run without threading

We can introduce a flag e.g. use_docker to determine the running environment and adjust the behavior accordingly that users are able to run both locally and using Docker.

@jenniferjiangkells jenniferjiangkells converted this from a draft issue Jun 6, 2024
@jenniferjiangkells jenniferjiangkells added Issue: Feature Request ✨ New feature or improvement to existing feature good first issue Good for newcomers and removed good first issue Good for newcomers labels Jun 6, 2024
@jenniferjiangkells jenniferjiangkells moved this from Ready to Todo in HealthChain Sep 16, 2024
@TanyaKansal
Copy link

@jenniferjiangkells do we need this now? Also can we add hacktoberfest label to this issue?

@jenniferjiangkells
Copy link
Member Author

@TanyaKansal you're welcome to work on this if you want! I will add the label and description

@TanyaKansal
Copy link

Thanks

@jenniferjiangkells jenniferjiangkells added hacktoberfest Issues suitable for hacktoberfest Component: Sandbox Issue/PRs that deal with the client and server components of the sandbox labels Oct 8, 2024
@jenniferjiangkells
Copy link
Member Author

@TanyaKansal I've updated the description and added it to hacktoberfest. Apologies the sandbox isn't as well documented so please let me know if you have any questions!

@TanyaKansal
Copy link

sure, thanks @jenniferjiangkells

@iniminimini
Copy link

Can I contribute to this issue?

@TanyaKansal
Copy link

@jenniferjiangkells please assign this issue to me so that others don't work on it

@jenniferjiangkells
Copy link
Member Author

@TanyaKansal We don't typically assign issues, your comment lets us and others know that it's already being worked on - just open the PR when you're ready 🙂

@iniminimini It looks like this issue is already being worked on, but you're welcome to take a look at the other open issues to see if there's anything else you'd like to work on!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Sandbox Issue/PRs that deal with the client and server components of the sandbox hacktoberfest Issues suitable for hacktoberfest Issue: Feature Request ✨ New feature or improvement to existing feature
Projects
Status: Todo
Development

No branches or pull requests

3 participants