Getting Started

Use Supabase with SvelteKit

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

1

Create a Supabase project

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

When your project is up and running, go to the Table Editor, create a new table and insert some data.

Alternatively, you can run the following snippet in your project's SQL Editor. This will create a instruments table with some sample data.

1
2
3
4
5
6
7
8
9
10
11
12
13
-- Create the tablecreate table instruments (  id bigint primary key generated always as identity,  name text not null);-- Insert some sample data into the tableinsert into instruments (name)values  ('violin'),  ('viola'),  ('cello');alter table instruments enable row level security;

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

1
2
3
4
create policy "public can read instruments"on public.instrumentsfor select to anonusing (true);
2

Create a SvelteKit app

Create a SvelteKit app using the npm create command.

1
npx sv create my-app
3

Install the Supabase client library

The fastest way to get started is to use the supabase-js client library which provides a convenient interface for working with Supabase from a SvelteKit app.

Navigate to the SvelteKit app and install supabase-js.

1
cd my-app && npm install @supabase/supabase-js
4

Create the Supabase client

Create a src/lib directory in your SvelteKit app, create a file called supabaseClient.js and add the following code to initialize the Supabase client with your project URL and public API (anon) key:

Project URL
Anon key
1
2
3
import {  } from '@supabase/supabase-js'  export const  = ('https://<project>.supabase.co', '<your-anon-key>')
5

Query data from the app

Use load method to fetch the data server-side and display the query results as a simple list.

Create +page.server.js file in the src/routes directory with the following code.

1
2
3
4
5
6
7
8
import { supabase } from "$lib/supabaseClient";  export async function load() {    const { data } = await supabase.from("instruments").select();    return {      instruments: data ?? [],    };  }

Replace the existing content in your +page.svelte file in the src/routes directory with the following code.

1
2
3
4
5
6
7
8
9
<script>    let { data } = $props();  </script>  <ul>    {#each data.instruments as instrument}      <li>{instrument.name}</li>    {/each}  </ul>
6

Start the app

Start the app and go to http://localhost:5173 in a browser and you should see the list of instruments.

1
npm run dev

Next steps