Skip to content

OmniStack Backend Documentation

Welcome to the OmniStack Backend documentation! This is a production-ready FastAPI backend boilerplate for SaaS applications.

  • Getting Started

    Set up your development environment in 60 seconds

    Quick Start

  • API Reference

    Complete endpoint documentation with request/response examples

    API Docs

  • Architecture

    System design, patterns, and naming conventions

    Architecture

  • Modular Guide

    Pick and choose only the components you need

    Customize

  • Frontend Integration

    TypeScript types, React, Next.js, iOS, and Android examples

    Integration

  • Contributing

    Code style, testing requirements, and PR process

    Contribute

Features

Core

  • JWT Authentication - Supabase, Clerk, or custom OAuth
  • Generic CRUD - Reusable patterns with pagination
  • Soft Delete - Non-destructive data removal
  • Rate Limiting - Redis-backed sliding window
  • Security Headers - CORS, CSP, HSTS

External Services (Pluggable)

Service Providers
AI Gateway OpenAI, Anthropic, Google Gemini
Email Resend, SendGrid
Storage AWS S3, Cloudflare R2, Cloudinary
Payments Stripe, Apple IAP, Google Play

Observability

  • Prometheus metrics
  • Sentry error tracking
  • Structured JSON logging

Tech Stack

Component Technology
Runtime Python 3.12+
Framework FastAPI
ORM SQLModel (Pydantic + SQLAlchemy)
Database PostgreSQL 16+
Cache Redis 7+
Background Jobs ARQ
Testing Pytest
Linting Ruff

Philosophy

"Zero to API in 60 seconds, Zero to Production in 60 minutes"

This boilerplate follows:

  • 12-Factor App - All config via environment variables
  • Adapter Pattern - Swap providers without changing business logic
  • Clean Architecture - Business logic separated from HTTP layer
  • Async-First - Non-blocking I/O everywhere

Support

v1.0 - Production Ready