README.md

fastapi-template

FastAPI server template.

Installation

1. Install Python

You can install Python using pyenv on macOS or Linux. On Windows, you can use pyenv-win.

2. Install dependencies

You can install the dependencies using pip and the requirements.txt and requirements-test.txt files.

pip install -r requirements.txt

pip install -r requirements-test.txt

3. Run the application

You can run the application using uvicorn.

uvicorn main:app --reload

The --reload flag enables hot reloading so the server will automatically reload when you make changes to your code. You should see output indicating that the server is running, typically on http://127.0.0.1:8000.

View docs

View API documentation at http://127.0.0.1:8000/docs#/.