DOCS UPDATE: Fix Backend Setup Documentation: Correct Uvicorn Execution Path
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- fastapi, python
- Domain
- backend, documentation
Research direction
Locate the existing backend setup documentation referenced by the issue and verify the current Uvicorn instructions against the Backend/ and app/ package layout. Update the documented command and explain the relative-import error and init.py requirement; done means a new contributor can start the FastAPI server from Backend/ without this import error.
Written by the indexing model from the issue text.
Description
Is this related to an existing part of the documentation?
- Yes, it is related to an existing section
What needs to be updated?
Current Documentation Issue
The backend setup documentation does not clearly specify the correct way to run the FastAPI server when using relative imports inside the app/ package.
Currently, running the server from inside the app/ directory using:
cd Backend/app
uvicorn main:app --reload
results in the following error:
ImportError: attempted relative import with no known parent package
This happens because main.py uses relative imports (e.g., from .db.db import engine), and running Uvicorn from inside the app/ directory prevents Python from recognizing app as a package.
-The documentation does not clarify:
-That the server must be run from the project root (Backend/)
-The correct Uvicorn command format
-The requirement for init.py files inside package directories
-This can confuse new contributors during local setup.
Proposed Changes
Update the backend setup documentation to:
Clearly instruct users to run the server from the Backend/ root directory.
Provide the correct command:
cd Backend
uvicorn app.main:app --reload
Add a note explaining why running from inside app/ causes import errors.
This will improve onboarding clarity and prevent common setup mistakes for contributors.
Relevant Documentation Link (if any)
No response
Record
- I agree to follow this project's Code of Conduct
- I want to work on this update
- Dominant language
- TypeScript
- Stars
- 102
- Forks
- 144
- PR merge metrics
- No merged PRs in 30d
Getting set up
We have not checked this project's setup files yet. Start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from AOSSIE-Org/InPactAI
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
AOSSIE-Org/InPactAI#218 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
AOSSIE-Org/InPactAI#201 ·
-
Difficulty 5/5 Over a week Newbie friendliness 42/100
AOSSIE-Org/InPactAI#314 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
AOSSIE-Org/InPactAI#312 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 50/100
AOSSIE-Org/InPactAI#307 · 2 comments ·
All issues in AOSSIE-Org/InPactAI
Similar issues
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 88/100
StabilityNexus/Fate-EVM-Frontend#153 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
code-yeongyu/oh-my-openagent#9039 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Tencent/teamai-cli#862 ·
Maintainers usually reply within 1 day
-
bug good first issue hacktoberfest redis
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
libredb/libredb-studio#1164 ·
Maintainers usually reply within 1 day
-
flake
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day