Use Supabase with Flutter

1. Create a Supabase project#

Before you can use Supabase, you need a Supabase project. You can create a project visually in the Dashboard or programmatically using the Management API.

2. Install agent skills (optional)#

Agent Skills are curated instruction sets that give your AI agent procedural knowledge about working with Supabase.

Install them in your project with:

1
npx skills add supabase/agent-skills

3. Set up your database#

When your Supabase project is up and running, create an instruments table with some sample data. Then set only the privileges each Postgres role needs, add Row Level Security (RLS) for enhanced security for database data by default, and create an RLS policy to make the data in the table publicly readable.

Or do this manually in your project's SQL Editor, by pasting the SQL below, and clicking Run.

1
-- Create the table
2
create table instruments (
3
  id bigint primary key generated always as identity,
4
  name text not null
5
);
6
7
-- Insert sample data into the table
8
insert into instruments (name)
9
values
10
  ('violin'),
11
  ('viola'),
12
  ('cello');
13
14
-- Grant the privileges the role needs, which is read access
15
grant select on public.instruments to anon;
16
17
-- Enable row level security for the table
18
alter table instruments enable row level security;
19
20
-- Create a policy to allow the anon role to read from the instruments table
21
create policy "public can read instruments"
22
on public.instruments
23
for select to anon
24
using (true);

4. Create a Flutter app#

Create a Flutter app using the flutter create command.

1
flutter create my_app

5. 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.

1
supabase_flutter: ^2.0.0

Get API details#

To interact with data in database tables, you use the client libraries that wrap the auto-generated Data API endpoints, authenticating using the Project URL and key from the project Connect dialog.

6. Initialize the Supabase client#

Open lib/main.dart and edit the main function to initialize Supabase using your project URL and publishable key, which you can get from the helper above, or from the project Connect panel:

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
    publishableKey: 'YOUR_SUPABASE_PUBLISHABLE_KEY',
9
  );
10
  runApp(MyApp());
11
}

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

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
}

8. 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 web, iOS, Android, macOS, and Windows apps. Running the app on macOS requires additional configuration to set the entitlements.

1
flutter run

9. Setup deep links (optional)#

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 production, your 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 this, add 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>