FastAPI-Template

GitHub repository

Glitch live demo

Setup

1. Install Python 3.6 or higher.
2. Install pip dependencies with pip install -r requirements.txt or pip3 install -r requirements.txt for Mac/Linux users.
3. Copy or rename .env_example to .env in the root of the project folder.
4. Optionally create a GitHub personal access token and store it under github_token in your .env file to run the GitHub example routes.
5. Run the application with uvicorn main:app --reload

In addition, for VSCode Users:

1. Install the Python extension and Pylance extension.
2. Recommended: Install the VS Intellicode extension for better code suggestions/completion.
3. VSCode tasks are included in this repo as well: press 'F1' or 'Ctrl + Shift + P' and select 'Run Tasks' to access them.
4. You may also run or debug the application using the included debug profile.

Developing with FastAPI

• FastAPI Docs

• Python Types for FastAPI