Skip to content
Getting Started

Use Supabase with Astro

Learn how to create a Supabase project, add sample data, and query from an Astro app.

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.

Create a new Supabase project from the Dashboard of any organization you belong to.

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.

Prefill SQL

3. Create an Astro app#

Create an Astro app using the npm create command.

1
npm create astro@latest my-app
2
cd my-app

4. Install Supabase client library and Node adapter#

Install the supabase-js client library and the @astrojs/node adapter to enable server-side rendering.

1
npm install @supabase/supabase-js @astrojs/node

5. Configure Astro for SSR#

Update your astro.config.mjs.

astro.config.mjs
1
import node from '@astrojs/node'
2
import { defineConfig } from 'astro/config'
3
4
export default defineConfig({
5
  output: 'server',
6
  adapter: node({
7
    mode: 'standalone',
8
  }),
9
})

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.

Project URL
Publishable key

6. Declare Supabase environment variables#

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

1
PUBLIC_SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>
2
PUBLIC_SUPABASE_PUBLISHABLE_KEY=<SUBSTITUTE_SUPABASE_PUBLISHABLE_KEY>

7. Create a Supabase client helper#

Create a utility file to initialize the Supabase client:

src/lib/supabase.ts
1
import { createClient } from '@supabase/supabase-js'
2
3
const supabaseUrl = import.meta.env.PUBLIC_SUPABASE_URL
4
const supabasePublishableKey = import.meta.env.PUBLIC_SUPABASE_PUBLISHABLE_KEY
5
6
export function createServerClient() {
7
  return createClient(supabaseUrl, supabasePublishableKey)
8
}

8. Query Supabase data from Astro#

Create a new file at src/pages/instruments.astro and populate with the following.

This queries all rows from the instruments table you created earlier and renders them on the page.

src/pages/instruments.astro
1
---
2
import { createServerClient } from "../lib/supabase";
3
4
const supabase = createServerClient();
5
const { data: instruments } = await supabase.from("instruments").select();
6
---
7
8
<html>
9
  <head>
10
    <title>Instruments</title>
11
  </head>
12
  <body>
13
    <ul>
14
      {instruments?.map((instrument) => (
15
        <li>{instrument.name}</li>
16
      ))}
17
    </ul>
18
  </body>
19
</html>

9. Start the app#

Run the development server, go to http://localhost:4321/instruments in your browser of choice to check the list of instruments.

1
npm run dev

Next steps#