Skip to content

Supabase KMP Documentation

Supabase KMP is a Kotlin Multiplatform SDK for Supabase designed around explicit result handling, modular architecture, and broad target support.

What this documentation covers

This documentation is intentionally comprehensive and split into practical tracks:

  • Setup and bootstrapping for real projects
  • Architecture and design tradeoffs
  • Complete module-by-module usage
  • API reference maps and conventions
  • Operations guidance (security, reliability, releases)
  • Troubleshooting for common failures
  • Contributor workflows and quality gates

Audience

  • App engineers integrating Supabase into KMP apps
  • Platform teams building shared Kotlin client layers
  • Maintainers extending or contributing to the SDK

Quick start path

  1. Getting Started
  2. Architecture
  3. Authentication Guide
  4. Database Guide
  5. Production Checklist

Repository

  • GitHub: https://github.com/AndroidPoet/supabase-kmp
  • Main project README: https://github.com/AndroidPoet/supabase-kmp/blob/main/README.md
  • Docs site (GitHub Pages): https://androidpoet.github.io/supabase-kmp/

Documentation systems in this repo

  • MkDocs (primary): mkdocs.yml + docs/
  • GitBook (existing): .gitbook.yaml + docs/

You can publish from the same content tree to either system.