docs: remove quotes from echo command for windows cross-platform compatibility#194
docs: remove quotes from echo command for windows cross-platform compatibility#194Mohit-001-hash wants to merge 1 commit into
Conversation
|
@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. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe PR updates the README's Frontend Setup section to correct the ChangesFrontend Setup Documentation
🎯 1 (Trivial) | ⏱️ ~2 minutes
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
🎉 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
💬 Join Our Community Channel — This is MandatoryBeing part of our communication channel is compulsory for all contributors, not optional. 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. 🚀✨ |
📌 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