BUG #123: Fix backend dev setup instructions

[compiler041]

This PR fixes broken backend setup instructions.
A fresh clone previously failed due to missing configuration steps.
The README now documents required config creation, MongoDB setup, and the correct command to run the backend.

Summary by CodeRabbit

• Documentation
  • Enhanced backend setup guide with clear prerequisites for Go and MongoDB.
  • Simplified configuration workflow by using provided sample config file as template.
  • Clarified MongoDB URI requirements and optional Gemini API feature configuration.
  • Updated backend startup instructions and security notes regarding config file handling.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Only README.md is modified. The changes reorganize backend prerequisites, configuration setup, and running instructions, shifting the approach from manual configuration snippets to using a sample config file (config.prod.sample.yml) as a template with enhanced clarity on MongoDB requirements and API configuration.

Changes

Cohort / File(s)

Summary

Documentation - Setup Instructions README.md

Added Backend Prerequisites section for Go and MongoDB. Reworked Backend Configuration to use config.prod.sample.yml as template instead of manual pasting. Introduced MongoDB configuration step with URI requirement. Updated Gemini API description as optional. Modified Running the Backend section. Added Notes section emphasizing not committing config.prod.yml. Updated frontend environment setup instructions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• Update README.md #95: Overlapping changes to README.md with frontend environment setup and configuration instructions.
• Updated README.md #92: Related backend configuration and README.md updates affecting config.prod.yml setup guidance.

Suggested reviewers

• bhavik-mangla

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly addresses the main objective of fixing broken backend development setup instructions documented in the README, making it clear and specific about the primary change.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 251aa47 and e23564d.

📒 Files selected for processing (1)

• README.md

🔇 Additional comments (1)

README.md (1)

32-90: Backend setup instructions are clear and comprehensive.

The reorganization from manual config snippets to a sample-file-copy workflow is a solid improvement. The Prerequisites section, MongoDB requirement documentation, optional Gemini API guidance, and security notes in the Notes section all work well together to guide developers through a fresh setup without confusion.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

README.md (1)

93-134: Clarify the frontend .env configuration to eliminate duplication.

The frontend setup has two sections that create .env files with conflicting information:

• Lines 95–106 show .env with both VITE_BASE_URL and VITE_GOOGLE_CLIENT_ID
• Lines 124–128 show .env creation again with only VITE_BASE_URL

If VITE_GOOGLE_CLIENT_ID is required (as stated in line 104), the second section is incomplete. If it's optional, the first section overstates the requirement. Consolidate these two sections into a single, authoritative setup flow to avoid developer confusion.

🔎 Suggested consolidation

Remove the redundant "2. Create a .env file" from the Running the Frontend section (lines 124–128) and ensure the Frontend Configuration section (lines 93–106) is referenced as the single source of truth for environment setup. Alternatively, if the sections serve different purposes, clarify which variables are required vs. optional.

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 251aa47 and e23564d.

📒 Files selected for processing (1)

• README.md

🔇 Additional comments (1)

README.md (1)

32-90: Backend setup instructions are clear and comprehensive.

The reorganization from manual config snippets to a sample-file-copy workflow is a solid improvement. The Prerequisites section, MongoDB requirement documentation, optional Gemini API guidance, and security notes in the Notes section all work well together to guide developers through a fresh setup without confusion.