Skip to content
Getting Started

Use Supabase with Next.js

Learn how to create a Supabase project, add some sample data, and query from a Next.js 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. Install agent skills (optional)#

Agent Skills are curated instruction sets that give your AI agent procedural knowledge about working with Supabase.

Install them in your project with:

1
npx skills add supabase/agent-skills

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

Or do this manually in your project's SQL Editor, by pasting the SQL below, and clicking Run.

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);

4. Create a Next.js app#

Use the create-next-app command and the with-supabase template, to create a Next.js app pre-configured with Cookie-based Auth, TypeScript, and Tailwind CSS.

1
npx create-next-app -e with-supabase

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

5. Declare Supabase environment variables#

Rename .env.example to .env.local and populate with your Supabase connection variables that you can get from the helper above, or from the project Connect panel.

Open Connect panel
.env.local
1
NEXT_PUBLIC_SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>
2
NEXT_PUBLIC_SUPABASE_PUBLISHABLE_KEY=<SUBSTITUTE_SUPABASE_PUBLISHABLE_KEY>

6. Query Supabase data from Next.js#

Create a new file at app/instruments/page.tsx and populate with the following.

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

1
import { createClient } from "@/lib/supabase/server";
2
import { Suspense } from "react";
3
4
async function InstrumentsData() {
5
  const supabase = await createClient();
6
  const { data: instruments } = await supabase.from("instruments").select();
7
8
  return <pre>{JSON.stringify(instruments, null, 2)}</pre>;
9
}
10
11
export default function Instruments() {
12
  return (
13
    <Suspense fallback={<div>Loading instruments...</div>}>
14
      <InstrumentsData />
15
    </Suspense>
16
  );
17
}

7. Start the app#

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

1
npm run dev

Next steps#