-
Notifications
You must be signed in to change notification settings - Fork 36
Add .env.example files for all components with documentation #73
Copy link
Copy link
Open
Labels
Stellar WaveIssues in the Stellar wave programIssues in the Stellar wave programdevexDeveloper experience improvementDeveloper experience improvementdocumentationImprovements or additions to documentationImprovements or additions to documentationeasyDifficulty: EasyDifficulty: Easygood first issueGood for newcomersGood for newcomers
Description
Problem
Environment variable requirements are unclear. Some .env.example files exist but don't document which variables are required vs optional.
Context
Developers waste time debugging configuration issues that could be caught at setup time.
Proposed Solution
Update/create .env.example files for API and Oracle with:
- Comments explaining each variable
- Required vs optional marking
- Example values for testnet
- Links to where to get values (e.g., Stellar Laboratory for keys)
Acceptance Criteria
-
api/.env.examplewith all variables documented -
oracle/.env.examplewith all variables documented - Required vs optional clearly marked
- Example values are safe (testnet, not mainnet)
Technical Notes
- Files:
api/.env.example,oracle/.env.example
Constraints
- Never include real secrets in examples
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
Stellar WaveIssues in the Stellar wave programIssues in the Stellar wave programdevexDeveloper experience improvementDeveloper experience improvementdocumentationImprovements or additions to documentationImprovements or additions to documentationeasyDifficulty: EasyDifficulty: Easygood first issueGood for newcomersGood for newcomers