Use Supabase with TanStack Start

1. Create a Supabase project#

Before you can use Supabase, you need a Supabase project. You can create a project visually in the Dashboard or programmatically using the Management API.

2. Set up your database#

When your Supabase project is up and running, create an instruments table with some sample data.

Then set a secure baseline by setting 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 your table publicly readable.

You can click this button to prefill all the SQL needed in the SQL editor of your project in the Dashboard.

3. Create a TanStack Start app#

Create a TanStack Start app using the official CLI.

1
npm create @tanstack/start@latest my-app -- --package-manager npm --toolchain biome

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

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

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.

5. Declare Supabase environment variables#

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

1
VITE_SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>
2
VITE_SUPABASE_PUBLISHABLE_KEY=<SUBSTITUTE_SUPABASE_PUBLISHABLE_KEY>

6. Create a Supabase client utility#

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

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
)

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

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

8. Start the app#

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

1
npm run dev

Next steps#

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