supabase

supabase

https://github.com/supabase/supabase

Supabase

Supabase is the Postgres development platform. We're building the features of Firebase using enterprise-grade open source tools.

• Hosted Postgres Database. Docs
• Authentication and Authorization. Docs
• Auto-generated APIs.
  • REST. Docs
  • GraphQL. Docs
  • Realtime subscriptions. Docs
• Functions.
  • Database Functions. Docs
  • Edge Functions Docs
• File Storage. Docs
• AI + Vector/Embeddings Toolkit. Docs
• Dashboard

Watch "releases" of this repo to get notified of major updates.

 

How it works

Supabase is a combination of open source tools. We’re building the features of Firebase using enterprise-grade, open source products. If the tools and communities exist, with an MIT, Apache 2, or equivalent open license, we will use and support that tool. If the tool doesn't exist, we build and open source it ourselves. Supabase is not a 1-to-1 mapping of Firebase. Our aim is to give developers a Firebase-like developer experience using open source tools.

Architecture

Supabase is a hosted platform. You can sign up and start using Supabase without installing anything. You can also self-host and develop locally.

• Postgres is an object-relational database system with over 30 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance.
• Realtime is an Elixir server that allows you to listen to PostgreSQL inserts, updates, and deletes using websockets. Realtime polls Postgres' built-in replication functionality for database changes, converts changes to JSON, then broadcasts the JSON over websockets to authorized clients.
• PostgREST is a web server that turns your PostgreSQL database directly into a RESTful API.
• GoTrue is a JWT-based authentication API that simplifies user sign-ups, logins, and session management in your applications.
• Storage a RESTful API for managing files in S3, with Postgres handling permissions.
• pg_graphql a PostgreSQL extension that exposes a GraphQL API.
• postgres-meta is a RESTful API for managing your Postgres, allowing you to fetch tables, add roles, and run queries, etc.
• Kong is a cloud-native API gateway.

Client libraries

Our approach for client libraries is modular. Each sub-library is a standalone implementation for a single external system. This is one of the ways we support existing tools.

Language	Client	Feature-Clients (bundled in Supabase client)
	Supabase	PostgREST	GoTrue	Realtime	Storage	Functions
⚡️ Official ⚡️
JavaScript (TypeScript)	supabase-js	postgrest-js	gotrue-js	realtime-js	storage-js	functions-js
Flutter	supabase-flutter	postgrest-dart	gotrue-dart	realtime-dart	storage-dart	functions-dart
Swift	supabase-swift	postgrest-swift	auth-swift	realtime-swift	storage-swift	functions-swift
Python	supabase-py	postgrest-py	gotrue-py	realtime-py	storage-py	functions-py
💚 Community 💚
C#	supabase-csharp	postgrest-csharp	gotrue-csharp	realtime-csharp	storage-csharp	functions-csharp
Go	-	postgrest-go	gotrue-go	-	storage-go	functions-go
Java	-	-	gotrue-java	-	storage-java	-
Kotlin	supabase-kt	postgrest-kt	auth-kt	realtime-kt	storage-kt	functions-kt
Ruby	supabase-rb	postgrest-rb	-	-	-	-
Rust	-	postgrest-rs	-	-	-	-
Godot Engine (GDScript)	supabase-gdscript	postgrest-gdscript	gotrue-gdscript	realtime-gdscript	storage-gdscript	functions-gdscript

Badges

Architecture#

Supabase is a combination of open source tools, each specifically chosen for Enterprise-readiness.

If the tools and communities already exist, with an MIT, Apache 2, or equivalent open license, we will use and support that tool. If the tool doesn't exist, we build and open source it ourselves.

• Kong is a cloud-native API gateway.
• GoTrue is an JWT based API for managing users and issuing JWT tokens.
• PostgREST is a web server that turns your Postgres database directly into a RESTful API
• Realtime is an Elixir server that allows you to listen to Postgres inserts, updates, and deletes using WebSockets. Realtime polls Postgres' built-in replication functionality for database changes, converts changes to JSON, then broadcasts the JSON over WebSockets to authorized clients.
• Storage provides a RESTful interface for managing Files stored in S3, using Postgres to manage permissions.
• postgres-meta is a RESTful API for managing your Postgres, allowing you to fetch tables, add roles, and run queries, etc.
• Postgres is an object-relational database system with over 30 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance.
• Supavisor is a scalable connection pooler for Postgres, allowing for efficient management of database connections.

For the system to work cohesively, some services require additional configuration within the Postgres database. For example, the APIs and Auth system require several default roles and the pgjwt Postgres extension.

You can find all the default extensions inside the schema migration scripts repo. These scripts are mounted at /docker-entrypoint-initdb.d to run automatically when starting the database container.