Add setup instructions for sync microservice

[nishantxscooby]

Fixes #881

This PR adds documentation for setting up and running the sync-microservice component.

Summary by CodeRabbit

• Documentation
  • Added sync microservice setup instructions with virtual environment and dependency installation steps
  • Updated service startup procedures and environment configuration documentation

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

[nishantxscooby]

I’ve opened PR #881 adding setup instructions for the sync microservice.

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR adds Python setup documentation for the sync-microservice to address issue #881. The main README.md references a new "Sync Microservice Setup" section, while sync-microservice/README.md provides detailed setup instructions including virtual environment creation, dependency installation, and service startup via python main.py.

Changes

Cohort / File(s)	Summary
Documentation Updates README.md, sync-microservice/README.md	Adds "Sync Microservice Setup" sections with venv creation, pip install, and service startup instructions (replaces prior .sync-env / uvicorn startup documentation)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• Update build pipeline to support the microservice. #492 — Related through shared startup instruction changes (python main.py vs. uvicorn invocation) and environment setup (venv vs. .sync-env) documented here

Suggested labels

GSoC 2025

Poem

🐰 A microservice now blooms with care,
With instructions clear and fair,
venv and pip, then python runs,
Setup docs bring helpful fun!

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly and concisely describes the main change—adding setup instructions for the sync microservice, which is the core objective of the PR.
Linked Issues check	✅ Passed	The PR addresses issue #881 by adding a Sync-microservice Setup section to README with virtual environment and run instructions as specified.
Out of Scope Changes check	✅ Passed	All changes are directly related to adding setup documentation for the sync microservice as required by issue #881, with no unrelated modifications.
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 a91a07d and 68a8d6c.

📒 Files selected for processing (2)

• README.md
• sync-microservice/README.md

🔇 Additional comments (1)

README.md (1)

33-35: Reference is clear and well-placed.

The addition appropriately directs users to the sync-microservice setup documentation. However, note that the referenced file contains conflicting setup instructions (see critical issue flagged in sync-microservice/README.md review).

---

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)

sync-microservice/README.md (1)

21-45: Critical: Duplicate and conflicting setup instructions create user confusion.

The file now contains two "Sync Microservice Setup" / "Installation" sections (lines 21–45 and 194–205) with fundamentally incompatible instructions:

Aspect	Lines 21–45	Lines 194–205
Venv name	.sync-env	venv
Activation	source .sync-env/bin/activate	source venv/bin/activate
Startup command	uvicorn main:app --reload --port 8001	python main.py

The startup commands are mutually exclusive: uvicorn main:app expects main.py to export a FastAPI app object for uvicorn to serve, while python main.py expects the script to be executable and self-starting. Both cannot be correct.

This creates ambiguity for contributors and will likely cause setup failures depending on which instructions are followed.

Recommended fix: Consolidate into a single, definitive setup section. Remove the duplicate (lines 194–205) and update lines 21–45 with the correct approach. If both methods are intentionally supported, document when/why to use each.

Also applies to: 194-205

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a91a07d and 68a8d6c.

📒 Files selected for processing (2)

• README.md
• sync-microservice/README.md

🔇 Additional comments (1)

README.md (1)

33-35: Reference is clear and well-placed.

The addition appropriately directs users to the sync-microservice setup documentation. However, note that the referenced file contains conflicting setup instructions (see critical issue flagged in sync-microservice/README.md review).