Package detailsv2.16.5

supabase

A dart client for Supabase. This client makes it simple for developers to build secure and scalable products.

AndroidiOSWebmacOSWindowsLinux

pub.dev API documentation Source code

30-day downloads: 1.3M
Likes: 618
Pub points: 150

Install package

flutter pub add supabase

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

Supabase is a Dart client that enables developers to easily integrate Supabase's backend services into Flutter applications. It provides secure, real-time access to databases, authentication, file storage, and more, all with minimal setup. The client supports multiple platforms including Android, iOS, Web, macOS, Windows, and Linux, making it ideal for cross-platform app development. With built-in support for JWT authentication and row-level security, Supabase helps developers build scalable and secure applications quickly.

Use cases

Real-time data synchronization
User authentication and authorization
Cloud-based file storage
Backend-as-a-Service for Flutter apps
Scalable database operations

Key features

Real-time database subscriptions
Built-in authentication (email, OAuth)
Row-level security
File storage with presigned URLs
Cross-platform compatibility

Suitable for

Full-stack Flutter developers
Startups building MVPs
Apps requiring real-time updates
Teams needing secure backend services
Projects with multi-platform deployment

Considerations

Requires a Supabase project setup
Network dependency for backend operations
Rate limits on free tier
Need to manage API keys securely
Limited offline capabilities without additional logic

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

Supabase Flutter

Flutter client library for Supabase.

Guides · Reference Docs · Migration Guides

Run locally

This repo is a monorepo powered by Melos containing supabase_flutter and its sub-libraries. All packages are located in the packages directory.

To install on a locally developed app:

Clone this repo
Install Melos globally if you haven't already: dart pub global activate melos
Run melos bootstrap or melos bs at the root of the cloned directory to install dependencies

Add the target package to your pubspec.yaml file specifying the path.

supabase_flutter:
  path: <your-path-to-the-local-supabase-flutter-repo>/packages/supabase_flutter

Testing your app

The helpers the test suites of these packages run on are published in package:supabase_test, so your tests can build on the same primitives: mock HTTP clients, JWT builders, auth session fixtures and realtime frames. Add the package as a dev dependency:

dev_dependencies:
  supabase_test: ^0.1.0

Then stub the endpoints the code under test talks to and run it against a real SupabaseClient, with no running stack required:

final httpClient = MockSupabaseHttpClient()
  ..stubTable('todos', rows: [
    {'id': 1, 'task': 'Ship it', 'status': false},
  ]);
final supabase = testSupabaseClient(httpClient: httpClient);
addTearDown(supabase.dispose);

final todos = await supabase.from('todos').select();
expect(todos, hasLength(1));

See the supabase_test README for the full guide: stubbing database, rpc, edge function and auth endpoints, asserting on recorded requests, running tests as a signed-in user, and wiring Supabase.initialize in Flutter widget tests.

Testing this repo

The tests for the packages postgrest, supabase_auth, supabase_realtime and supabase_storage run against a local Supabase stack. To run these tests locally you need docker and the Supabase CLI installed.

The single configuration for the stack lives in the supabase directory at the repository root. Start it with:

supabase start

Run the Dart tests within the package directory in packages/<package> with the following command. The -j 1 flag runs the tests not concurrently, which works better since the tests run against the same services.