Skip to content
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#

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 a React app#

Create a React app using a Vite template.

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

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

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

6. Declare Supabase environment variables#

Create a .env.local file and populate it with your Supabase URL and publishable key that you can get from the helper below, or from the project Connect panel

Open Connect panel
.env.local
1
VITE_SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>
2
VITE_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

7. Query data from the app#

Replace the contents of App.jsx with a getInstruments function that fetches the data and displays the query result on the page using a Supabase client.

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

8. Start the app#

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

1
npm run dev

Next steps#