Getting Started¶

Welcome to the FastAPI HTTP/WebSocket Template! This guide will help you get up and running quickly.

Prerequisites¶

Before you begin, ensure you have the following installed:

• Python 3.13+ - Download Python
• Docker & Docker Compose - Install Docker
• uv - Python package manager: pip install uv
• Git - Version control

Quick Setup¶

Follow these three steps to get started:

1. Installation - Set up your development environment
2. Quick Start - Create your first endpoints
3. Configuration - Configure services and environment

What You'll Build¶

By the end of this guide, you'll have:

• ✅ A running FastAPI application with HTTP and WebSocket support
• ✅ Keycloak authentication with JWT tokens
• ✅ PostgreSQL database with migrations
• ✅ Redis for caching and rate limiting
• ✅ Prometheus metrics and Grafana dashboards
• ✅ Full observability stack (logs, metrics, traces)

Learning Path¶

Next Steps¶