docs(backend): complete .env.example with all referenced environment variables - #1152
Open
Oyinkans0la12 wants to merge 1 commit into
Open
docs(backend): complete .env.example with all referenced environment variables#1152Oyinkans0la12 wants to merge 1 commit into
Oyinkans0la12 wants to merge 1 commit into
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.
Closes #1101
Summary
Update
backend/.env.exampleto include every environment variable referenced throughout the backend, making local setup more reliable and reducing configuration-related onboarding issues.Problem
backend/.env.exampleis intended to be the canonical template for local development, but it does not currently include all environment variables consumed by the backend. As a result, new contributors can encounter runtime failures caused by missing configuration values that are not documented.Solution
This PR audits all backend
process.env.*references and synchronizesbackend/.env.exampleso every required environment variable is represented with an appropriate placeholder value and brief documentation.Implementation Details
Environment Variable Audit
Reviewed environment variable usage across backend configuration and supporting libraries, including:
backend/src/config/**backend/src/lib/pg-pool.tsbackend/src/lib/redis.tsbackend/src/services/sorobanService.tsprocess.env.*.env.exampleUpdatesUpdated:
backend/.env.exampleChanges include:
Scope
This PR intentionally does not:
Testing
Validation performed by:
process.env.*references,.env.example,Behavioral Changes
None.
This PR improves configuration documentation only and does not affect application behavior.
Checklist
process.env.*references..env.example.