Skip to content
Getting Started

Use Supabase with iOS and SwiftUI

Learn how to create a Supabase project, add some sample data to your database, and query the data from an iOS app.

1. Create a Supabase project#

To start, you need a Supabase project.

Create a new Supabase project from the Dashboard of any organization you belong to.

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

Do these steps within your project's dashboard by copying and running the snippet in your project's SQL Editor.

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);

3. Create an iOS SwiftUI app with Xcode#

Select the Xcode > New Project > iOS > App menu item.

4. Install Agent Skills (optional)#

Supabase's Agent Skills is a curated set of instructions that give your AI agent procedural knowledge about working with Supabase.

To install, run the following command in the root of your project:

1
npx skills add supabase/agent-skills

5. Install the Supabase client library#

Add the supabase-swift package to your app using the Swift Package Manager.

In Xcode, navigate to File > Add Package Dependencies... and enter the repository URL https://github.com/supabase/supabase-swift in the search bar. For detailed instructions, see Apple's tutorial on adding package dependencies.

Make sure to add Supabase product package as a dependency to your application target.

6. Initialize the Supabase client#

Create a new Supabase.swift file add a new Supabase instance using your project URL and publishable key, which you can get from the helper below, or from the project Connect panel:

Open Connect panel
Supabase.swift
1
import Supabase
2
3
let supabase = SupabaseClient(
4
  supabaseURL: URL(string: "YOUR_SUPABASE_URL")!,
5
  supabaseKey: "YOUR_SUPABASE_PUBLISHABLE_KEY"
6
)

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.

Project URL
Publishable key

7. Create a data model for instruments#

Create a decodable struct to deserialize the data from the database.

Add the following code to a new file named Instrument.swift.

Instrument.swift
1
struct Instrument: Decodable, Identifiable {
2
  let id: Int
3
  let name: String
4
}

8. Query data from the app#

Use a task to fetch the data from the database and display it using a List.

Replace the default ContentView with the following code.

ContentView.swift
1
import SwiftUI
2
3
struct ContentView: View {
4
5
  @State var instruments: [Instrument] = []
6
7
  var body: some View {
8
    List(instruments) { instrument in
9
      Text(instrument.name)
10
    }
11
    .overlay {
12
      if instruments.isEmpty {
13
        ProgressView()
14
      }
15
    }
16
    .task {
17
      do {
18
        instruments = try await supabase.from("instruments").select().execute().value
19
      } catch {
20
        dump(error)
21
      }
22
    }
23
  }
24
}

9. Start the app#

Run the app on a simulator or a physical device by hitting Cmd + R on Xcode.

If you want to implement authentication features like magic links or OAuth, you need to set up deep links to redirect users back to your app. For instructions on configuring custom URL schemes for your iOS app, see the deep linking guide.

Next steps#