Getting Started

Use Supabase with Nuxt

Learn how to create a Supabase project, add some sample data to your database, and query the data from a Nuxt app.


1

Create a Supabase project

Go to database.new and create a new Supabase project.

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
2
3
4
5
6
7
8
9
10
11
12
13
-- Create the tablecreate table instruments ( id bigint primary key generated always as identity, name text not null);-- Insert some sample data into the tableinsert into instruments (name)values ('violin'), ('viola'), ('cello');alter table instruments enable row level security;

Make the data in your table publicly readable by adding an RLS policy:

1
2
3
4
create policy "public can read instruments"on public.instrumentsfor select to anonusing (true);
2

Create a Nuxt app

Create a Nuxt app using the npx nuxi command.

1
npx nuxi@latest init my-app
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 Nuxt app.

Navigate to the Nuxt app and install supabase-js.

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

Query data from the app

In app.vue, create a Supabase client using your project URL and public API (anon) key:

Project URL
Anon key

Replace the existing content in your app.vue file with the following code.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<script setup>import { createClient } from '@supabase/supabase-js'const supabase = createClient('https://<project>.supabase.co', '<your-anon-key>')const instruments = ref([])async function getInstruments() { const { data } = await supabase.from('instruments').select() instruments.value = data}onMounted(() => { getInstruments()})</script><template> <ul> <li v-for="instrument in instruments" :key="instrument.id">{{ instrument.name }}</li> </ul></template>
5

Start the app

Start the app, navigate to http://localhost:3000 in the browser, open the browser console, and you should see the list of instruments.

1
npm run dev