Skip to content

docs: add environment variables summary section - #127

Open
Muskankr wants to merge 2 commits into
Sahilll94:mainfrom
Muskankr:docs-env-summary
Open

docs: add environment variables summary section#127
Muskankr wants to merge 2 commits into
Sahilll94:mainfrom
Muskankr:docs-env-summary

Conversation

@Muskankr

Copy link
Copy Markdown

Pull Request Description

Summary

Added a structured Environment Variables Summary section to the README to clearly document required frontend environment variables.
This improves onboarding for new contributors and prevents configuration confusion.

Type of Change

  • Documentation update

Related Issues

Please link any related issues:

  • Fixes #(issue number)
  • Related to #(issue number)

Motivation and Context

Why is this change required? What problem does it solve?

Changes Made

  • Added 🔐 Environment Variables Summary section
  • Listed all required frontend environment variables
  • Added instruction to copy .env.example to .env

Screenshots (if applicable)

If your changes include UI modifications, please add before and after screenshots:

Before:

After:

Testing

  • I have tested these changes locally
  • I have added tests that prove my fix is effective or that my feature works
  • All new and existing tests pass
  • I have tested the changes on different screen sizes (for UI changes)
  • I have tested in both light and dark mode (for UI changes)

Code Quality

  • My code follows the existing code style of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • [ x] I have made corresponding changes to the documentation
  • [ x] My changes generate no new warnings or errors

Deployment

  • These changes require no deployment steps
  • These changes require database migrations (please describe)
  • These changes require environment variable updates (please describe)

Breaking Changes

If this is a breaking change, please describe the impact and migration path for existing users:

Additional Notes

Add any other context about the pull request here:


Contributor Checklist

  • [ x] I have read and followed the Contributing Guidelines
  • [x ] I have checked that this PR doesn't duplicate an existing PR
  • I have assigned appropriate labels to this PR
  • I have requested review from relevant team members
  • I am ready to apply for contributor recognition after this PR is merged

For Maintainers

  • Code review completed
  • Tests passing
  • Documentation updated
  • Ready to merge

@vercel

vercel Bot commented Feb 24, 2026

Copy link
Copy Markdown

@Muskankr is attempting to deploy a commit to the Sahil's projects Team on Vercel.

A member of the Team first needs to authorize it.

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @Muskankr, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the project's documentation by introducing a dedicated section in the README.md for environment variables. The primary goal is to streamline the setup process for developers by providing clear, concise information about necessary configurations, thereby preventing common setup errors and improving overall developer experience.

Highlights

  • Documentation Update: Added a new, structured 'Environment Variables Summary' section to the README.md file.
  • Improved Onboarding: Clearly documented all required frontend environment variables, enhancing the onboarding process for new contributors and reducing configuration confusion.
  • Configuration Guidance: Included a table listing specific environment variables (e.g., VITE_BACKEND_URL, Firebase keys) and instructions to copy .env.example to .env.
Changelog
  • README.md
    • Added a new top-level section titled '🔐 Environment Variables Summary'.
    • Included a subsection '🌐 Frontend (.env)' detailing frontend environment variables.
    • Provided a markdown table listing VITE_BACKEND_URL, VITE_GOOGLE_MAPS_API_KEY, and several Firebase-related environment variables with their descriptions.
    • Added a warning and instruction regarding copying .env.example to .env and not committing .env files.
Activity
  • No specific activity (comments, reviews, or progress updates) has been recorded for this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds a much-needed summary of environment variables to the README.md, which will significantly improve the onboarding experience for new contributors. The documentation is well-structured and clear. I've suggested a few minor refinements to further improve clarity and formatting, mainly by streamlining the instructions for setting up the .env file and making the variable descriptions more explicit. Overall, this is an excellent documentation update.

Comment thread README.md Outdated
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
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.

1 participant