Skip to content

docs: fix FastAPI startup command in README - #127

Open
ASP-31 wants to merge 1 commit into
sunithvs:mainfrom
ASP-31:main
Open

ASP-31 wants to merge 1 commit into
sunithvs:mainfrom
ASP-31:main

Conversation

@ASP-31

@ASP-31 ASP-31 commented Oct 31, 2026 •

Copy link
Copy Markdown

Summary

Updated the FastAPI startup command in the README to match the project's actual application structure.

Description

The README previously instructed users to run:

uvicorn main:app --reload

The FastAPI application is located in api/main.py, so the command has been updated to:

uvicorn api.main:app --reload --port 8000

Motivation and Context

The previous command could fail when following the README setup instructions because main.py is inside the api directory.

This change keeps the documentation consistent with the current project structure and the setup instructions in CONTRIBUTING.md.

How has this been tested?

This is a documentation-only change. No application code was modified.

The updated command was checked against the repository structure, where the FastAPI application is defined in api/main.py.

Screenshots (if appropriate)

Not applicable.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

@vercel

vercel Bot commented Oct 31, 2026

Copy link
Copy Markdown
Contributor

@ASP-31 is attempting to deploy a commit to the lamsta Team on Vercel.

A member of the Team first needs to authorize it.

This branch has not been deployed

No deployments
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