docs: expand Docker Compose local dev section#991
Open
vanshikagupta2005 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.
Description
Expanded the Docker Compose section in
README.mdwhich previously only containeda single command (
docker compose up --build) with no setup guidance.Problem
New contributors had no documentation on how to run the full local stack
(backend + frontend + PostgreSQL) using Docker Compose.
Changes made
Added a detailed local development section covering:
Expected Behavior
A contributor can follow the README alone to spin up the full stack locally
and verify it works via
curl http://localhost:8000/healthz/readyRelated Issue
Fixes #462
Type of change
Checklist
mainpytest -vand all tests passdocs: add Docker Compose local development sectionScreenshots (if frontend change)
N/A — documentation change only.
Test evidence
N/A — this is a documentation-only change. No code was modified,
so no pytest run is required. Existing tests remain unaffected.