Skip to content

docs: update README with correct Uvicorn command for src structure #727

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

vinay22573
Copy link

📌 Description

This PR updates the README to include the correct Uvicorn command when the project follows a src/ structure. This helps prevent ImportErrors and ensures users can run the application smoothly.


🔹 Changes Made

✅ Added a note in the README to clarify the correct way to start the FastAPI server when main.py is inside src/.
✅ Provided the correct Uvicorn command:

uvicorn src.main:app --reload

✅ Checklist

  • I have read the Contribution Guidelines.
  • I have tested these changes locally.
  • I have updated the documentation (README).
  • The code follows the project's documentation and formatting standards.

Copy link

vercel bot commented Mar 21, 2025

@vinay22573 is attempting to deploy a commit to the Main Team on Vercel.

A member of the Team first needs to authorize it.

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