Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

DOCS UPDATE: Fix Backend Setup Documentation: Correct Uvicorn Execution Path

Aperta
  • Qualcosa non va?
#299 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
fastapi, python
Ambito
backend, documentation

Direzione di ricerca

Individua la documentazione esistente sulla configurazione del backend a cui fa riferimento l’issue e verifica le istruzioni attuali per Uvicorn rispetto alla struttura dei package Backend/ e app/. Aggiorna il comando documentato e spiega l’errore di importazione relativa e il requisito di init.py; il lavoro è completato quando un nuovo contributore può avviare il server FastAPI da Backend/ senza questo errore di importazione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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
Image

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
Lingua principale
TypeScript
Stelle
102
Fork
144
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Non abbiamo ancora controllato i file di configurazione di questo progetto. Parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di AOSSIE-Org/InPactAI

Tutte le issue di AOSSIE-Org/InPactAI

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.