Closes #425#469
Merged
Merged
Conversation
- Rewrite .env.example with a one-line description for every variable and remove duplicate entries; group into required vs optional - Add an 'Environment variables' section to CONTRIBUTING.md covering required vs optional vars and where to source testnet RPC URLs
|
@T-kesh Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
3 tasks
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
2 participants
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 #425. New contributors had no reference for which environment variables are needed to run the client locally, what each does, or where to get the values. This documents all of them.
Changes
.env.example — added a one-line description comment for every variable, removed the duplicate VITE_BACKEND_URL and UTM blocks, and grouped variables into Required (defaults provided) vs Optional sections with a copy-to-.env header.
CONTRIBUTING.md — added an Environment variables section that:
explains the VITE_ prefix convention and points to src/utils/env.utils.ts as the validation source of truth
tables out required vs optional variables with descriptions
documents where to source testnet RPC URLs (Base Sepolia public endpoint, Alchemy/Infura/Chainlist for Sepolia, local Anvil)
updated the local setup steps to use cp .env.example .env and link to the new section
Acceptance criteria
Every variable in .env.example has a description comment
Contributor guide explains required vs optional vars
Testnet RPC URL source is documented