This project is a FastAPI application that requires the installation of specific Python packages. Follow the instructions below to set up and run the project in a development environment.
- Python 3.7+
- FastAPI
- Enum package
-
Clone the repository (if needed).
git clone https://github.com/yourusername/yourproject.git cd yourproject
-
Install dependencies
-
Install
FastAPI
with the standard dependencies:pip install "fastapi[standard]"
-
Install
enum
:pip install enum
-
To start the FastAPI server in development mode, run:
uvicorn main:app --reload
Replace main
with the name of your Python file (e.g., main.py
if that's the file containing the FastAPI app).
For development, use the following command:
fastapi dev main.py
This command will start the FastAPI app with live reloading enabled, making it easier to test changes on the fly.
Once the server is running, you can access the interactive API documentation by visiting:
- 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.