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#

To start, you need a Supabase project.

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 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 the table publicly readable.

Do these steps within your project's dashboard by copying and running the snippet in your project's SQL Editor.

1
-- Create the table
2
create table instruments (
3
  id bigint primary key generated always as identity,
4
  name text not null
5
);
6
7
-- Insert sample data into the table
8
insert into instruments (name)
9
values
10
  ('violin'),
11
  ('viola'),
12
  ('cello');
13
14
-- Grant the privileges the role needs, which is read access
15
grant select on public.instruments to anon;
16
17
-- Enable row level security for the table
18
alter table instruments enable row level security;
19
20
-- Create a policy to allow the anon role to read from the instruments table
21
create policy "public can read instruments"
22
on public.instruments
23
for select to anon
24
using (true);

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 Agent Skills (optional)#

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

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

1
npx skills add supabase/agent-skills

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

6. 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
})

7. Declare Supabase environment variables#

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

Open Connect panel
.env.local
1
PUBLIC_SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>
2
PUBLIC_SUPABASE_PUBLISHABLE_KEY=<SUBSTITUTE_SUPABASE_PUBLISHABLE_KEY>

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

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

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

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