FastAPI Template

A production-ready FastAPI project template with modern best practices, async support, JWT authentication, and PostgreSQL integration.

✨ Features

• 🚀 FastAPI - Modern, fast web framework for building APIs, with versioned routers (/v1, /v2)
• 📊 PostgreSQL - Async database integration with SQLAlchemy 2.0 and Alembic migrations
• 🔐 JWT Authentication - Secure token-based authentication with token blacklisting
• 🏗️ Clean Architecture - Repository pattern, dependency injection, and enforced module boundaries (tach)
• 🔒 Security - CSRF, rate limiting, and security headers middleware
• 🐳 Docker Compose - Backend, Postgres, and Redis ready to run
• 🧪 CI & Testing - Pytest with coverage gating, plus lint/type/security checks in GitHub Actions

Plus optional integrations for caching, background jobs, cloud storage, Firebase, Apple Pay, and email delivery. For the full list of integrations and services, see docs/features.md.

🚀 Quick Start

Prerequisites

• Python 3.14+
• PostgreSQL
• uv

Installation

1. Clone the repository

   git clone 
   cd FastApi-Template
   

2. Install dependencies

   Create a virtual environment

   python -m venv .venv
   

   Activate the virtual environment

   # On Linux / macOS
   source .venv/bin/activate
   # On Windows (PowerShell)
   .venv\Scripts\Activate.ps1
   

   Install dependencies

   # Install dependencies
   uv sync --all-groups
   
   # Install optional integrations as needed
   uv sync --all-groups --all-extras
   
   # Install pre-commit hooks
   pre-commit install
   

   Note: If you are facing SSL issues on Windows, use:

   uv sync --all-groups --native-tls
   uv sync --native-tls --all-extras
   

3. Set up environment variables

   cp .env.example .env
   # Edit .env with your configuration
   

4. Configure database

      # Create database
      createdb fastapi_template
   
      # Run migrations
      alembic upgrade head
   

5. Start the development server

      python main.py