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

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 Next.js app

Use the create-next-app command and the with-supabase template, to create a Next.js app pre-configured with:

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

Declare Supabase Environment Variables

Rename .env.example to .env.local and populate with your Supabase connection variables:

Project URL
Publishable key
Anon key
1
NEXT_PUBLIC_SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>
2
NEXT_PUBLIC_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.

4

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 in Supabase and render 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
}
5

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