feat: add Dockerfile and Docker usage documentation#35
Open
raztud wants to merge 2 commits into
Open
Conversation
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
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
Details
The Dockerfile uses python:3.12-slim and installs the package via pip directly (leveraging the poetry-core build backend), keeping the image small and free of unnecessary tooling.
By default the container starts an empty Mimicker server on port 8080. Users can define their routes by mounting a Python stub file:
Or by extending the image with their own Dockerfile.
Test plan
docker build -t mimicker .- completes successfullydocker run -p 8080:8080 mimicker- starts the server (returns 404 with no routes configured)stubs.pywith GET/POST routes responds correctly (curl returns expected JSON) - described in README