Getting Started

Use Supabase with React

Learn how to create a Supabase project, add some sample data to your database, and query the data from a React 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 section of the Dashboard, create a new table and insert some data. Then in the Integrations > Data API section of the Dashboard, expose the specific tables or functions you want to access. To automatically grant access for new tables and functions in public, enable Default privileges for new entities.

Alternatively, you can run the following snippet in your project's SQL Editor.

This creates an instruments table with some sample data, sets a secure baseline by setting only the privileges each Postgres role needs, and adds Row Level Security (RLS) for enhanced security for database data by default.

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;

Create an RLS policy to make the data in your table publicly readable:

1
-- Create a policy to allow the anon role to read from the instruments table
2
create policy "public can read instruments"
3
on public.instruments
4
for select to anon
5
using (true);
2

Create a React app

  • Create a React app using a Vite template.

Terminal
1
npm create vite@latest my-app -- --template react
3

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

Navigate to the React app and install supabase-js.

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

Declare Supabase Environment Variables

Create a .env.local file and populate with your Supabase connection variables:

Project URL
Publishable key
1
VITE_SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>
2
VITE_SUPABASE_PUBLISHABLE_KEY=<SUBSTITUTE_SUPABASE_PUBLISHABLE_KEY>

You can also get the Project URL and key from the project's Connect dialog.

Get API details#

Now that you've created some database tables, you are ready to insert data using the auto-generated API.

To do this, you need to get the Project URL and key from the project Connect dialog.

Read the API keys docs for a full explanation of all key types and their uses.

5

Query data from the app

Replace the contents of App.jsx to add a getInstruments function to fetch the data and display the query result to the page using a Supabase client.

src/App.jsx
1
import { useEffect, useState } from "react";
2
import { createClient } from "@supabase/supabase-js";
3
4
const supabase = createClient(import.meta.env.VITE_SUPABASE_URL, import.meta.env.VITE_SUPABASE_PUBLISHABLE_KEY);
5
6
function App() {
7
  const [instruments, setInstruments] = useState([]);
8
9
  useEffect(() => {
10
    getInstruments();
11
  }, []);
12
13
  async function getInstruments() {
14
    const { data } = await supabase.from("instruments").select();
15
    setInstruments(data);
16
  }
17
18
  return (
19
    <ul>
20
      {instruments.map((instrument) => (
21
        <li key={instrument.name}>{instrument.name}</li>
22
      ))}
23
    </ul>
24
  );
25
}
26
27
export default App;
6

Start the app

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

Terminal
1
npm run dev

Next steps#