Supabase Flutter

Flutter client library for Supabase.

Guides · Reference Docs · Migration Guides

This repository holds the Supabase client libraries for Dart and Flutter. This README describes v3. Most Supabase Dart examples published elsewhere are v2 code, which no longer compiles. To upgrade a v2 project, follow MIGRATION.md.

Which package to use

supabase_flutter and supabase bring in the service clients, which you do not add yourself: postgrest, supabase_auth, supabase_realtime, supabase_storage, supabase_functions and iceberg.

Supabase Service Compatibility

The Supabase Dart and Flutter SDKs only guarantee compatibility with the latest release of each Supabase service, unless a minimum supported version is explicitly listed below.

Older service releases are supported on a best-effort basis, but compatibility is not guaranteed.

If you self-host Supabase, we recommend upgrading your services to their latest releases when upgrading the SDK.

Quick start

Add the package and the schema generator:

flutter pub add supabase_flutter
flutter pub add dev:supabase_typegen

Generate the typed schema of your database with the Supabase CLI, version 2.122.0 or newer:

supabase gen types --lang dart --local > lib/supabase_schema.g.dart

Initialize Supabase once, then query through the generated types, imported from supabase_schema.g.dart:

```dart file import 'package:flutter/material.dart'; import 'package:supabase_flutter/supabase_flutter.dart';

import 'supabase_schema.g.dart';

Future main() async { WidgetsFlutterBinding.ensureInitialized(); await Supabase.initialize( url: 'https://your-project.supabase.co', publishableKey: 'your-publishable-key', ); runApp(const MaterialApp(home: Placeholder())); }

Future> booksInPrint() { return Supabase.instance.client .table(Books.table) .select() .where(Books.inPrint.isTrue()) .order(Books.title); }

The [`supabase_flutter` README](https://github.com/supabase/supabase-flutter/blob/HEAD/packages/supabase_flutter/README.md) walks
through every part of the API.

## Using an AI coding agent

`supabase_flutter`, `supabase`, `supabase_typegen` and `supabase_test` ship
[package skills](https://dart.dev/ai/package-skills), instructions that teach
coding agents such as Claude Code, Cursor, Gemini or Copilot the v3 API.
Agents trained on v2 examples otherwise tend to write code that does not
compile. Install the skills of every package you use, with `supabase` in
place of `supabase_flutter` in a Dart project without Flutter:

```sh
dart run skills@ get -p supabase_flutter
dart run skills@ get -p supabase_typegen
dart run skills@ get -p supabase_test

Run the commands again after upgrading the packages to update the skills.

Testing your app

supabase_test runs your tests against a real SupabaseClient whose HTTP requests are answered by stubs and whose realtime socket runs in memory, so no running stack is needed:

dart pub add dev:supabase_test

```dart test final httpClient = MockSupabaseHttpClient() ..stubTable( 'books', rows: [ {'id': 1, 'author_id': 2, 'title': 'Dune', 'in_print': true}, ], ); final supabase = testSupabaseClient(httpClient: httpClient); addTearDown(supabase.dispose);

final books = await supabase.table(Books.table).selectOnly([ Books.id, Books.title, ]);

expect(books.single.read(Books.title), 'Dune');

See the [supabase_test README](https://github.com/supabase/supabase-flutter/blob/HEAD/packages/supabase_test/README.md) 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.

## Run locally

This repository is a monorepo powered by [Melos](https://melos.invertase.dev/).
All packages are in the `packages` directory.

To use a local checkout in an app:

- Clone this repository.
- Install Melos if you have not already: `dart pub global activate melos`.
- Run `melos bootstrap`, or `melos bs`, at the root of the clone to install
  the dependencies.
- Point the dependency in your `pubspec.yaml` at the local package:

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

## 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](https://supabase.com/docs/guides/local-development/cli/getting-started) installed.

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

```bash
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.

dart test -j 1

To stop the stack run the following command from the repository root:

supabase stop

Contributing

• Fork the repo on GitHub
• Clone the project to your own machine
• Commit changes to your own branch
• Push your work back up to your fork
• Submit a Pull request so that we can review your changes and merge

License

This repo is licensed under MIT.

Resources

• Quickstart: Flutter
• Flutter Tutorial: building a Flutter chat app
• Flutter Tutorial - Part 2: Authentication and Authorization with RLS