Skip to content
Getting Started

Use Supabase with SolidJS

Learn how to create a Supabase project, add some sample data to your database, and query the data from a SolidJS 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. Set up your database#

When your Supabase project is up and running, create an instruments table with some sample data.

Then set a secure baseline by setting 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 your table publicly readable.

You can click this button to prefill all the SQL needed in the SQL editor of your project in the Dashboard.

Prefill SQL

3. Create a SolidJS app#

Create a SolidJS app using the degit command.

1
npx degit solidjs/templates/js my-app

4. 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 SolidJS app.

Navigate to the SolidJS app and install supabase-js.

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

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#

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

1
VITE_SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>
2
VITE_SUPABASE_PUBLISHABLE_KEY=<SUBSTITUTE_SUPABASE_PUBLISHABLE_KEY>

6. Query data from the app#

In App.jsx, create a Supabase client to fetch the instruments data.

Add a getInstruments function to fetch the data and display the query result to the page.

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

7. Start the app#

Start the app and go to http://localhost:3000 in a browser and you should see the list of instruments.

1
npm run dev