docs: Improved .env.example and Updated README#238
Merged
imDarshanGK merged 7 commits intoMay 22, 2026
Conversation
shreyaundage
changed the title
Added environment variables for AI provider and cache settings.
imDarshanGK
added
good first issue
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.
Description
Improved environment configuration documentation and onboarding setup instructions for contributors.
Added missing environment variables to .env.example and updated the README with clearer local environment setup guidance.
Related Issue
Fixes #206
Type of change
Checklist
mainpytest -vand all tests passfeat/fix/docs/test: short descriptionChanges Made
Added missing JWT_SECRET variable to .env.example
Added missing DATABASE_URL variable to .env.example
Added environment setup instructions to README
Clarified important environment variables for local development
Added note about optional LLM provider configuration
Test evidence
55 passed in 1.79s