[Feat] : Adding Devcontainer Config & Specifications (#75). #135
+89
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces a .devcontainer folder to the docker/genai-stack repository, aiming to enhance the development environment setup for contributors leveraging Docker-Compose.
Changes Introduced:
Added
.devcontainer
folder containing:devcontainer.json
: A configuration file specifying settings for the development container, including extensions, environment variables, and more, to ensure consistent development environments across contributors.docker-compose.yml
: A YAML file defining the services, networks, and volumes for Docker-Compose, facilitating seamless deployment and scaling of the development environment.Purpose:
By integrating these files, we streamline the onboarding process for new contributors and ensure a consistent development environment regardless of the local setup. This addition enables contributors to spin up the necessary development environment effortlessly, reducing setup time and potential compatibility issues.
Benefits:
Improved Onboarding: New contributors can quickly set up their development environment by leveraging Docker-Compose.
Consistency: Ensures consistency in the development environment across different contributors' machines.
Ease of Deployment: Simplifies the deployment process with Docker-Compose, allowing for easy scaling and management.
Impact:
This addition optimizes the development workflow, fostering collaboration and accelerating the pace of development by minimizing setup overhead.
Testing:
The changes have been tested locally in a Macbook M1 chipset to ensure compatibility and functionality. However, additional testing from the community is welcome to validate the effectiveness of the setup across various environments.
Documentation:
Will update the project's
README.md
file to include instructions on utilizing the Devcontainer setup and Docker-Compose integration for seamless development, once changes are reviewed and approved for merge.Reviewer(s) Requested:
Feedback and review from the community and maintainers(@slimslenderslacks) are highly appreciated to ensure the effectiveness and correctness of the introduced changes.
Closing Notes:
This enhancement aligns with the goal of fostering a collaborative and efficient development environment within the docker/genai-stack project. Your feedback and contributions towards refining this setup are invaluable.