Async FastAPI Template

A production‑ready, fully async FastAPI template with everything you need to build modern APIs.

Features

• Async SQLAlchemy 2.0 + Alembic migrations
• JWT authentication with refresh tokens and role‑based access control (RBAC)
• WebAuthn / Passkey support (passwordless authentication)
• GraphQL endpoint with Strawberry (queries, mutations, subscriptions)
• Multi‑tenancy with Row‑Level Security via SQLAlchemy events
• File uploads (local & S3) with SSE streaming progress
• WebSocket chat with JWT auth
• Background tasks with Celery + Redis + retry/backoff
• Redis caching with cache‑aside, warming, and invalidation
• Rate limiting (per‑IP and per‑user) with slowapi
• Prometheus metrics + Grafana dashboards
• Distributed tracing with OpenTelemetry
• Email verification with Jinja2 templates and Celery retry
• CSV / Excel export and import utilities
• Security headers, SQL injection monitoring, XSS sanitisation
• Structured logging with structlog and correlation IDs
• Full‑text search (PostgreSQL tsvector) and audit logging
• Feature flags (env, cache, code defaults)
• Performance profiling (slow‑query logging, benchmarks, load tests)
• Scaffolding CLI – generate models, endpoints, and tests instantly
• HTMX‑powered admin dashboard with dark mode, inline editing, live search
• Docker Compose for dev and production
• Kubernetes manifests and Helm chart
• CI/CD workflows (matrix tests, PR linting, mutation testing, benchmark regression, automated releases)
• Snapshot testing (OpenAPI) and mutation testing (mutmut)
• Code quality enforced by Ruff, mypy, and pre‑commit
• Extensive documentation – quickstart, architecture, deployment, and more

Quickstart

git clone https://github.com/mavomen/async-fastapi-template.git
cd async-fastapi-template
chmod +x scripts/setup.sh && ./scripts/setup.sh
make dev

Visit http://localhost:8000/docs for the interactive API docs, http://localhost:8000/admin for the admin dashboard, or http://localhost:8000/graphql for the GraphQL playground.

Documentation

• Quickstart Guide
• API Documentation
• GraphQL Guide
• Architecture Decisions
• Database Setup
• Docker Guide
• Background Tasks
• Caching Strategy
• Rate Limiting
• File Storage
• WebSocket Usage
• Logging
• Metrics & Monitoring
• Health Checks
• Distributed Tracing
• Performance Tuning
• Email & Export
• Testing Guide
• Code Quality
• CI/CD
• Deployment
• Developer Experience
• FAQ
• Security
• Contributing
• Changelog

FAQ

Q: Can I use this for a production project? A: Yes! The template follows best practices and includes production‑ready configurations. Just replace the default secrets and configure your own infrastructure.

Q: Do I need Redis? A: Redis is used for caching, rate limiting, and Celery. You can disable these features if you don't need Redis, but it's recommended.

Q: How do I add a new feature? A: Run make scaffold to generate a model, endpoint, and tests. See the Developer Experience Guide.

Q: How do I contribute? A: Read CONTRIBUTING.md for guidelines on submitting pull requests.

License

MIT License — see the LICENSE file for details.