Use Supabase with Flutter

Learn how to create a Supabase projectadd some sample data to your databaseand query the data from a Flutter app.

Create a Supabase project

Go to database.new and create a new Supabase project.

Alternativelyyou can create a project using the Management API:

1
# Firstget your access token from https://supabase.com/dashboard/account/tokens
2
export SUPABASE_ACCESS_TOKEN="your-access-token"
3
4
# List your organizations to get the organization ID
5
curl -H "Authorization: Bearer $SUPABASE_ACCESS_TOKEN" \
6
  https://api.supabase.com/v1/organizations
7
8
# Create a new project (replace <org-id> with your organization ID)
9
curl -X POST https://api.supabase.com/v1/projects \
10
  -H "Authorization: Bearer $SUPABASE_ACCESS_TOKEN" \
11
  -H "Content-Type: application/on" \
12
  -d '{
13
    "organization_id": "<org-id>",
14
    "name": "My Project",
15
    "region": "us-east-1",
16
    "db_pass": "<your-secure-password>"
17
  }'

When your project is up and runninggo to the Table Editor section of the Dashboardcreate a new table and insert some data. Then in the Integrations > Data API section of the Dashboardexpose the specific tables or functions you want to access. To automatically grant access for new tables and functions in publicenable Default privileges for new entities.

Alternativelyyou can run the following snippet in your project's SQL Editor. This will create an instruments table with some sample data.

1
-- Create the table
2
create table instruments (
3
  id bigint primary key generated always as identity,
4
  name text not null
5
);
6
-- Insert some sample data into the table
7
insert into instruments (name)
8
values
9
  ('violin'),
10
  ('viola'),
11
  ('cello');
12
13
alter table instruments enable row level security;
14
15
-- Enable read access for the Data API
16
grant select on public.instruments to anon;

Make the data in your table publicly readable by adding an RLS policy:

1
create policy "public can read instruments"
2
on public.instruments
3
for select to anon
4
using (true);

Create a Flutter app

Create a Flutter app using the flutter create command. You can skip this step if you already have a working app.

Terminal

1
flutter create my_app

Install the Supabase client library

The fastest way to get started is to use the supabase_flutter client library which provides a convenient interface for working with Supabase from a Flutter app.

Open the pubspec.yaml file inside your Flutter app and add supabase_flutter as a dependency.

pubspec.yaml

1
supabase_flutter: ^2.0.0

Initialize the Supabase client

Open lib/main.dart and edit the main function to initialize Supabase using your project URL and publishable key:

Project URL

Publishable key

lib/main.dart

1
import 'package:supabase_flutter/supabase_flutter.dart';
2
3
Future<void> main() async {
4
  WidgetsFlutterBinding.ensureInitialized();
5
6
  await Supabase.initialize(
7
    url: 'YOUR_SUPABASE_URL',
8
    anonKey: 'YOUR_SUPABASE_PUBLISHABLE_KEY',
9
  );
10
  runApp(MyApp());
11
}

You can also get the Project URL and key from the project's Connect dialog.

Get API details#

Now that you've created some database tablesyou are ready to insert data using the auto-generated API.

To do thisyou need to get the Project URL and key from the project Connect dialog.

Read the API keys docs for a full explanation of all key types and their uses.

Changes to API keys

Supabase is changing the way keys work to improve project security and developer experience. You can read the full announcementbut in the transition periodyou can use both the current anon and service_role keys and the new publishable key with the form sb_publishable_xxx which will replace the older keys.

The legacy keys will be deprecated shortlyso we strongly encourage switching to and using the new publishable and secret API keys.

In most casesyou can get the correct key from the Project's Connect dialogbut if you want a specific keyyou can find all keys in the API Keys section of a Project's Settings page:

For new keysopen the API Keys tabif you don't have a publishable key alreadyclick Create new API Keysand copy the value from the Publishable key section.

Query data from the app

Use a FutureBuilder to fetch the data when the home page loads and display the query result in a ListView.

Replace the default MyApp and MyHomePage classes with the following code.

lib/main.dart

1
class MyApp extends StatelessWidget {
2
  const MyApp({super.key});
3
4
  @override
5
  Widget build(BuildContext context) {
6
    return const MaterialApp(
7
      title: 'Instruments',
8
      home: HomePage(),
9
    );
10
  }
11
}
12
13
class HomePage extends StatefulWidget {
14
  const HomePage({super.key});
15
16
  @override
17
  State<HomePage> createState() => _HomePageState();
18
}
19
20
class _HomePageState extends State<HomePage> {
21
  final _future = Supabase.instance.client
22
      .from('instruments')
23
      .select();
24
25
  @override
26
  Widget build(BuildContext context) {
27
    return Scaffold(
28
      body: FutureBuilder(
29
        future: _future,
30
        builder: (context, snapshot) {
31
          if (!snapshot.hasData) {
32
            return const Center(child: CircularProgressIndicator());
33
          }
34
          final instruments = snapshot.data!;
35
          return ListView.builder(
36
            itemCount: instruments.length,
37
            itemBuilder: ((context, index) {
38
              final instrument = instruments[index];
39
              return ListTile(
40
                title: Text(instrument['name']),
41
              );
42
            }),
43
          );
44
        },
45
      ),
46
    );
47
  }
48
}

Start the app

Run your app on a platform of your choosing! By default an app should launch in your web browser.

Note that supabase_flutter is compatible with webiOSAndroidmacOSand Windows apps. Running the app on macOS requires additional configuration to set the entitlements.

Terminal

1
flutter run

Setup deep links#

Many sign in methods require deep links to redirect the user back to your app after authentication. Read more about setting deep links up for all platforms (including web) in the Flutter Mobile Guide.

Going to production#

Android#

In productionyour Android app needs explicit permission to use the internet connection on the user's device which is required to communicate with Supabase APIs. To do thisadd the following line to the android/app/src/main/AndroidManifest.xml file.

1
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
2
  <!-- Required to fetch data from the internet. -->
3
  <uses-permission android:name="android.permission.INTERNET" />
4
  <!-- ... -->
5
</manifest>

Use Supabase with Flutter

Learn how to create a Supabase projectadd some sample data to your databaseand query the data from a Flutter app.

Create a Supabase project

Create a Flutter app

Terminal

Install the Supabase client library

pubspec.yaml

Initialize the Supabase client

Project URL

Publishable key

lib/main.dart

Get API details#

Changes to API keys

Query data from the app

lib/main.dart

Start the app

Terminal

Setup deep links#

Going to production#

Android#

Is this helpful?

AI Tools