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.

Alternatively, you can create a project using the Management API:

1
# First, get 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/json" \
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 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
-- 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;

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

Create a SvelteKit app

Create a SvelteKit app using the npm create command.

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

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

Declare Supabase Environment Variables

Create a .env file at the root of your project and populate with your Supabase connection variables:

Project URL
Publishable key
Anon key
1
PUBLIC_SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>
2
PUBLIC_SUPABASE_PUBLISHABLE_KEY=<SUBSTITUTE_SUPABASE_PUBLISHABLE_KEY>
5

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:

1
import { createClient } from '@supabase/supabase-js';
2
import { PUBLIC_SUPABASE_URL, PUBLIC_SUPABASE_PUBLISHABLE_KEY } from '$env/static/public';
3
4
export const supabase = createClient(PUBLIC_SUPABASE_URL, PUBLIC_SUPABASE_PUBLISHABLE_KEY)
6

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

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

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

Start the app

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

Terminal
1
npm run dev

Next steps