docs(dev): add local PostgreSQL setup examples#322
Closed
ArshSSandhu wants to merge 1 commit into
Closed
Conversation
Collaborator
|
The local development workflow will be changing with the merge of #316. Please refer to that for the best experience. |
Collaborator
|
#316 has been merged which obseletes this. |
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
This PR clarifies the local Docker Compose setup for new contributors by adding example PostgreSQL
.envvalues and common troubleshooting notes.Why
While setting up the project locally, Docker Compose can fail if required PostgreSQL environment variables, such as
POSTGRES_PASSWORD, are left blank after copyingexample.envto.env.This update makes the local development setup easier to follow, especially for contributors setting up the project for the first time.
Changes
.envvalues for Docker-based developmentPOSTGRES_PASSWORDdockerDesktopLinuxEngineerrorTesting
example.envto.envdocker compose up -d