Skip to content

Conversation

@g-k-s-03
Copy link
Contributor

@g-k-s-03 g-k-s-03 commented Nov 4, 2025

close #43

Description

This PR adds clear environment setup instructions to the README to help contributors properly configure their API keys and Supabase credentials.

Changes Made

  • Added "Environment Configuration" section with step-by-step setup instructions
  • Included instructions for both frontend (.env file) and backend (Supabase dashboard)
  • Added troubleshooting tips for common environment variable issues
  • Clear guidance on where to find API keys and credentials

Problem Solved

New contributors were getting "API key not found" errors because:

  • Environment setup documentation was missing
  • No clear instructions on how to configure .env file
  • No guidance on where to find Supabase credentials
  • No troubleshooting help for common setup issues

Testing

  • Followed the new instructions in a fresh clone - works correctly
  • Instructions are clear and actionable for new contributors

Notes

Focused on updating README.md as it's the primary documentation users see first. Happy to update other documentation files if maintainers prefer.

Closes environment setup gaps that were causing contributor frustration.

Summary by CodeRabbit

Documentation

  • Added Environment Configuration section to README with Frontend Environment Variables examples, including API credentials and database configuration keys required for application setup.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 4, 2025

Walkthrough

Added an "Environment Configuration" documentation section to the README featuring Frontend Environment Variables with example keys for GEMINI_API_KEY, VEXA_API_KEY, SUPABASE_URL, and SUPABASE_ANON_KEY. The environment block appears in two locations within the documentation.

Changes

Cohort / File(s) Change Summary
Documentation
README.md
Added "Environment Configuration" section with Frontend Environment Variables documentation, including example API keys and configuration values duplicated in two locations.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Pure documentation additions with no code logic or behavioral changes
  • Simple text and code fence additions with repetition of the same block

Poem

🐰 Hop, hop, hurrah! With README so bright,
Environment keys now documented just right,
Variables dance in your config so neat,
Documentation complete, the setup's sweet! 🎉

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: add environment configuration setup instructions' directly matches the PR objective of adding Environment Configuration documentation to the README with setup instructions for API keys and credentials.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BUG: Environment Variables Not Accessible Due to Missing Deno Permissions

1 participant