These instructions will help you set up and run the backend locally on your machine.
- Python (version 3.7 or higher)
- .env (create a
.env
file in the project root and add your environment variablescredentials
)
To install the dependencies
pip install -r requirements.txt
uvicorn app.main:app --reload
This command will:
- Launch the API in development mode (auto-reload on changes)
- Run the API on http://127.0.0.1:8000
- app/
- main.py: The main entry point for the FastAPI application.
- routers/: Directory containing route files for different API endpoints.
- database.py: Contains database connection setup.
- init.py: Initializes the app package.
FastAPI automatically generates documentation for your API. Once the server is running, you can access it at:
- Swagger UI: http://127.0.0.1:8000/docs
- ReDoc: http://127.0.0.1:8000/redoc
This project is licensed under the MIT License - see the LICENSE file for details.