Add Docker based development environment#1441
Open
swdee wants to merge 4 commits into
Open
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1441 +/- ##
============================================
- Coverage 58.48% 58.46% -0.03%
Complexity 8707 8707
============================================
Files 639 639
Lines 28146 28146
============================================
- Hits 16461 16455 -6
- Misses 11685 11691 +6 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
This PR adds a Docker based development environment for PartDB, allowing contributors to get started with only Docker and Docker Compose installed.
The existing
CONTRIBUTING.mddocuments the native PHP development workflow, which requires developers to manually install and configure PHP, Composer, Node.js, Yarn, and a database server. Having a containerized development environment makes setup for new developers much easier.This PR introduces an alternative workflow that provides a fully configured development environment using Docker while leaving the existing native workflow unchanged and closes issue #969 and also addresses past inquiries like #713 .
Changes
Dockerfile.devas a development image layered on top of the existing upstream production image.compose.dev.yamlfor running the Docker development environment..docker/dev/development entrypoint and helper scripts.DEVELOPMENT.mddocumenting the complete Docker development workflow.CONTRIBUTING.mdto referenceDEVELOPMENT.mdas an alternative development workflow.Features
The Docker development environment provides:
yarn watch.Developer Workflow
A new contributor can now set up a complete development environment with only Docker installed by following the instructions in
DEVELOPMENT.md.The documented workflow includes:
Notes
This PR intentionally does not replace the existing native development workflow.
Developers who prefer the existing PHP/Symfony workflow can continue using the instructions in
CONTRIBUTING.md. The Docker workflow is provided as an additional option.The development image is built on top of the existing production Docker image, so it remains aligned with the upstream runtime environment while adding the tools and configuration needed for development.