Use Supabase with SvelteKit

<$Partial path="quickstart_db_setup.mdx" />

3. Create a SvelteKit app

Create a SvelteKit app using the npm create command.

npx sv create my-app

4. Install Supabase's Agent Skills (optional)

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

Install them so your AI coding agent can produce more accurate, reliable code using current Supabase patterns, such as authentication, server-side rendering, and database migrations, rather than relying solely on training data.

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

npx skills add supabase/agent-skills

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

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

6. Declare Supabase environment variables

Create a .env file at the root of your project and populate with your Supabase connection variables that you can get from the helper below, or from the project Connect panel:

PUBLIC_SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>
PUBLIC_SUPABASE_PUBLISHABLE_KEY=<SUBSTITUTE_SUPABASE_PUBLISHABLE_KEY>

<$Partial path="api_settings.mdx" variables={{ "framework": "sveltekit", "tab": "frameworks" }} />

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

<$CodeTabs>

import { createClient } from '@supabase/supabase-js'
import { PUBLIC_SUPABASE_PUBLISHABLE_KEY, PUBLIC_SUPABASE_URL } from '$env/static/public'

export const supabase = createClient(PUBLIC_SUPABASE_URL, PUBLIC_SUPABASE_PUBLISHABLE_KEY)

import { createClient } from '@supabase/supabase-js'
import { PUBLIC_SUPABASE_PUBLISHABLE_KEY, PUBLIC_SUPABASE_URL } from '$env/static/public'

export const supabase = createClient(PUBLIC_SUPABASE_URL, PUBLIC_SUPABASE_PUBLISHABLE_KEY)

</$CodeTabs>

8. Query data from the app

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

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

<$CodeTabs>

import { supabase } from '$lib/supabaseClient'

export async function load() {
  const { data } = await supabase.from('instruments').select()
  return {
    instruments: data ?? [],
  }
}

import { supabase } from '$lib/supabaseClient'

import type { PageServerLoad } from './$types'

type Instrument = {
  id: number
  name: string
}

export const load: PageServerLoad = async () => {
  const { data, error } = await supabase.from('instruments').select<'instruments', Instrument>()

  if (error) {
    console.error('Error loading instruments:', error.message)
    return { instruments: [] }
  }

  return {
    instruments: data ?? [],
  }
}

</$CodeTabs>

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

<script>
  let { data } = $props();
</script>

<ul>
  {#each data.instruments as instrument}
    <li>{instrument.name}</li>
  {/each}
</ul>

9. Start the app

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

npm run dev

Next steps

• Set up Auth for your app
• Insert more data into your database
• Upload and serve static files using Storage