Skip to content

docs: remove quotes from echo command for windows cross-platform compatibility#194

Open
Mohit-001-hash wants to merge 1 commit into
kunalverma2512:mainfrom
Mohit-001-hash:fix/frontend-env-docs
Open

docs: remove quotes from echo command for windows cross-platform compatibility#194
Mohit-001-hash wants to merge 1 commit into
kunalverma2512:mainfrom
Mohit-001-hash:fix/frontend-env-docs

Conversation

@Mohit-001-hash

@Mohit-001-hash Mohit-001-hash commented Jun 13, 2026

Copy link
Copy Markdown

📌 Pull Request Summary
🔗 Related Issue
Closes #

📝 Description
This pull request fixes a cross-platform environment setup bug in the frontend initialization instructions found inside the primary README.md file.

Changes Made
Located the frontend setup command block inside README.md.

Removed the literal double quotes from the command string: echo "VITE_API_BASE_URL=http://localhost:5000/api" > .env.

Updated it to: echo VITE_API_BASE_URL=http://localhost:5000/api > .env.

Motivation
On Unix-based operating systems (macOS and Linux), using echo with quotes strips them out when writing to a file. However, on Windows systems (specifically standard Command Prompt), the terminal copies the double quotes directly into the text file. This creates an .env file that reads VITE_API_BASE_URL="http://localhost:5000/api". Vite evaluates this literal quote syntax as part of the URL string itself, causing subsequent Axios API requests to fail due to string parsing contamination. Eliminating the quotes guarantees a seamless, cross-platform onboarding experience for all GSSoC contributors.

🚀 Type of Change
Select all that apply:

[ ] Bug Fix

[ ] New Feature

[ ] Enhancement

[x] Documentation Update

[ ] Refactoring

[ ] Performance Improvement

[ ] DevOps / Tooling

[ ] Other

🧪 Testing
Verification
[x] Tested Locally

[ ] Existing Tests Passed

[ ] New Tests Added

[ ] No Testing Required

Test Details
The command was manually tested on both a Windows CMD terminal and a Unix bash shell to verify that the generated .env file outputs a clean string mapping (VITE_API_BASE_URL=http://localhost:5000/api) without throwing system errors on either environment.

📸 Screenshots / Demo (If Applicable)
(Optional: You can attach a screenshot of your updated README file block here if your maintainers require it)

✅ Checklist
[x] I have read and followed the contribution guidelines.

[x] I have self-reviewed my changes.

[x] My changes are limited to the scope of this issue.

[x] Documentation has been updated where necessary.

[x] No unnecessary files or unrelated changes have been included.

[ ] The related issue has been linked correctly.

[x] All applicable testing and validation steps have been completed.

📚 Additional Notes
This is a minor but high-impact documentation fix aimed at reducing setup friction for Windows developers participating in GSSoC 2026.

Summary by CodeRabbit

  • Documentation
    • Updated Frontend Setup instructions in README to clarify proper environment variable configuration for improved cross-platform compatibility.

@vercel

vercel Bot commented Jun 13, 2026

Copy link
Copy Markdown

@Mohit-001-hash is attempting to deploy a commit to the Kunal Verma's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Jun 13, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 334ed78f-3563-4b54-8b70-435b37e56f04

📥 Commits

Reviewing files that changed from the base of the PR and between d99c217 and b18d436.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

The PR updates the README's Frontend Setup section to correct the .env file configuration instructions. The VITE_API_BASE_URL environment variable assignment was modified to remove surrounding quotes and includes a new inline note clarifying this adjustment is needed for Windows compatibility.

Changes

Frontend Setup Documentation

Layer / File(s) Summary
Environment variable configuration instructions
README.md
The VITE_API_BASE_URL assignment in the .env creation command is updated to remove quotes with an added note explaining the change is for Windows cross-platform compatibility.

🎯 1 (Trivial) | ⏱️ ~2 minutes

In docs where scripts dwell, 🐰
A quote was removed, all is well,
Windows shall now be free,
From quoting's symmetry,
Setup instructions cast their spell!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: removing quotes from an echo command for Windows cross-platform compatibility, which matches the core objective of the pull request.
Description check ✅ Passed The pull request description is comprehensive and follows the template structure with all major sections completed: related issue noted, clear description of changes, detailed motivation explaining the cross-platform issue, type of change selected, testing verification checked, and checklist mostly completed.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@github-actions

Copy link
Copy Markdown

🎉 Welcome to CodeLens — Thank You for Your Contribution!

Hey @Mohit-001-hash! 👋

We are genuinely excited to have you here. Every single PR — big or small — makes CodeLens better, and yours is no exception. Take a moment to review the checklist below to help us merge your work quickly and smoothly.

✅ Before Requesting a Review

  • Keep code clean, readable, and consistent with the existing codebase
  • Avoid unrelated or unnecessary file changes
  • Make sure the UI is fully responsive across all device sizes
  • Attach screenshots or a short screen recording for any UI changes
  • Resolve all merge conflicts before marking the PR as ready
  • Do not submit AI-generated, copy-pasted, or low-effort implementations

💬 Join Our Community Channel — This is Mandatory

Being part of our communication channel is compulsory for all contributors, not optional.

📡 Join the CodeLens Matrix Channel

Why join? This is where all important announcements, PR review updates, contribution discussions, and maintainer decisions happen in real time. Contributors who are not in the channel regularly miss critical context and updates, which often leads to duplicated or misaligned work. Staying connected here is what keeps the community strong and your contributions impactful.


We are rooting for you! If you have any questions, drop them in the channel or comment right here on this PR. Let's build something great together. 🚀✨

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