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

Feature Request: Enable Dockerization for the Project #509

Closed
eyadfarra opened this issue Oct 10, 2024 · 4 comments
Closed

Feature Request: Enable Dockerization for the Project #509

eyadfarra opened this issue Oct 10, 2024 · 4 comments
Labels
enhancement New feature or request

Comments

@eyadfarra
Copy link

Feature summary

Add Docker support to the project, allowing the application to run in a containerized environment for easier setup, development, and consistency.

Feature description

Introduce Docker support by adding a Dockerfile and docker-compose.yml to create a development environment using Docker. This update will also include modifications to the README.md to guide users on building, running, and stopping the application using Docker.

Motivation

Dockerizing the project simplifies the development setup by eliminating the need for a local Python installation. It ensures consistency across different environments, streamlines the onboarding process for new contributors, and makes dependency management more manageable.

Alternatives considered

  1. Manual Local Setup: Continue using the existing local installation setup. However, this approach requires users to install and configure Python and dependencies manually, leading to inconsistencies and potential version conflicts.

  2. Virtual Environments: Using Python virtual environments (e.g., venv) can isolate dependencies, but it still requires manual setup and lacks the benefits of containerization (e.g., OS-level consistency).

Additional context

No response

@eyadfarra eyadfarra added the enhancement New feature or request label Oct 10, 2024
@eyadfarra
Copy link
Author

Summary

I have created a branch with changes to support running the application on Docker instead of requiring a local Python installation. The updates include:

  • Adding a Dockerfile and docker-compose.yml to set up the development environment.
  • Modifying the README.md file to include instructions on how to build and run the application using Docker.

I have made local changes and created a new branch with the updates, but I am unable to push the new branch due to access restrictions. I would appreciate assistance in resolving this issue and guidance on how to proceed.

@LBuchananCates
Copy link

@eyadfarra That sounds amazing, can you fork this and share it in the event you can't push your branch? That'd solve so many of my problems.

@srtandon
Copy link

@eyadfarra Is there somewhere I can get the branch? I was just thinking I need a container for this. It would be super helpful.

@eyadfarra
Copy link
Author

@LBuchananCates @srtandon

Here’s the link to the PR:
PR #585 - Add Docker Support

@feder-cr feder-cr closed this as not planned Won't fix, can't repro, duplicate, stale Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants