Getting Started

Use Supabase with TanStack Start

Learn how to create a Supabase project, add some sample data to your database, and query the data from a TanStack Start 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 TanStack Start app

  • Create a TanStack Start app using the official CLI.

Terminal
1
npm create @tanstack/start@latest my-app -- --package-manager npm --toolchain biome
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 TanStack Start app.

Navigate to the TanStack Start app and install supabase-js.

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

Declare Supabase Environment Variables

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

Project URL
Publishable key
Anon key
1
VITE_SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>
2
VITE_SUPABASE_PUBLISHABLE_KEY=<SUBSTITUTE_SUPABASE_PUBLISHABLE_KEY>

You can also get the Project URL and key from the project's Connect dialog.

Read the API keys docs for a full explanation of all key types and their uses.

5

Create a Supabase client utility

Create a new file at src/utils/supabase.ts to initialize the Supabase client.

src/utils/supabase.ts
1
import { createClient } from "@supabase/supabase-js";
2
3
export const supabase = createClient(
4
  import.meta.env.VITE_SUPABASE_URL,
5
  import.meta.env.VITE_SUPABASE_PUBLISHABLE_KEY
6
);
6

Query data from the app

Replace the contents of src/routes/index.tsx with the following code to add a loader function that fetches the instruments data and displays it on the page.

src/routes/index.tsx
1
import { createFileRoute } from '@tanstack/react-router'
2
import { supabase } from '../utils/supabase'
3
4
export const Route = createFileRoute('/')({
5
  loader: async () => {
6
    const { data: instruments } = await supabase.from('instruments').select()
7
    return { instruments }
8
  },
9
  component: Home,
10
})
11
12
function Home() {
13
  const { instruments } = Route.useLoaderData()
14
15
  return (
16
    <ul>
17
      {instruments?.map((instrument) => (
18
        <li key={instrument.name}>{instrument.name}</li>
19
      ))}
20
    </ul>
21
  )
22
}
7

Start the app

Run the development server, go to http://localhost:3000 in a browser and you should see the list of instruments.

Terminal
1
npm run dev

Next steps