Skip to content

docs: add local setup verification steps#282

Open
Mohit-001-hash wants to merge 1 commit into
sahoo-tech:mainfrom
Mohit-001-hash:docs/add-local-setup-verification
Open

docs: add local setup verification steps#282
Mohit-001-hash wants to merge 1 commit into
sahoo-tech:mainfrom
Mohit-001-hash:docs/add-local-setup-verification

Conversation

@Mohit-001-hash

Copy link
Copy Markdown

🔗 Related Issue

Closes #None (documentation improvement)

Note: This PR is a documentation-only enhancement and is not associated with an existing issue.


📝 Summary of Changes

Added a Local Setup Verification subsection to the Running the Services Locally section of the README. The new documentation guides contributors on verifying that both the FastAPI backend and the SvelteKit dashboard are running correctly and communicating before beginning development. This helps identify environment or configuration issues early in the setup process.


🔍 Type of Change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📖 Documentation update
  • 🧪 Test addition or improvement
  • 🧹 Refactor / Code cleanup (no functional change)
  • ⚙️ Build / CI / Chore

🧪 How Was This Tested?

Verified that the new documentation integrates correctly with the existing setup instructions and accurately references the backend and dashboard endpoints.

# No code changes; documentation review only.

Test environment:

  • OS: Windows 11
  • Python version: Not applicable (documentation only)
  • Node version: Not applicable (documentation only)

📸 Screenshots / Recordings (if applicable)

Not applicable (documentation-only change).


✅ Pre-Submission Checklist

  • My branch is up to date with upstream/main
  • My code follows the project's coding standards (Black, isort, flake8 pass)
  • I have written / updated tests for my changes
  • All existing tests pass (python -m pytest tests/)
  • I have added docstrings and type hints to all new public functions
  • I have updated relevant documentation (README, docs/, inline comments)
  • My PR title follows the Conventional Commits format
  • I have not committed any .env files, secrets, or model weights
  • This PR addresses only the scope of the linked issue

💬 Additional Notes for Reviewer

This PR only improves the README by adding a verification step for local development. No source code, dependencies, or project behavior have been modified.

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