docs: add local setup verification steps#282
Open
Mohit-001-hash wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🔗 Related Issue
Closes #None (documentation improvement)
📝 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
🧪 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:
📸 Screenshots / Recordings (if applicable)
Not applicable (documentation-only change).
✅ Pre-Submission Checklist
upstream/mainpython -m pytest tests/).envfiles, secrets, or model weights💬 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.