chore: add .env.example documenting required environment variables#192
Open
ahmedabbas52233-a11y wants to merge 1 commit into
Open
chore: add .env.example documenting required environment variables#192ahmedabbas52233-a11y wants to merge 1 commit into
ahmedabbas52233-a11y wants to merge 1 commit into
Conversation
- Document VITE_API_BASE_URL with inline comments explaining purpose - Add cp .env.example .env step to README Quick Start - Add .env to .gitignore to prevent accidental secret commits - Improve contributor onboarding for new developers Closes Navin-xmr#183
Author
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
1 participant
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
Closes #183
Enhances the existing
.env.examplewith clear documentation and updates the README with setup instructions.Changes
frontend/.env.examplewith inline comments explainingVITE_API_BASE_URL.cp .env.example .envstep to README Quick Start.envto.gitignoreto prevent accidental secret commitspnpm run lintandpnpm run buildpass with zero warningsTesting
pnpm run lintpassespnpm run buildpassespnpm run devstarts without errors with.envcreated from exampleScreenshot