Use Supabase with Vue

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.

2. Install agent skills (optional)#

Agent Skills are curated instruction sets that give your AI agent procedural knowledge about working with Supabase.

Install them in your project with:

1
npx skills add supabase/agent-skills

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

Or do this manually in your project's SQL Editor, by pasting the SQL below, and clicking Run.

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);

4. Create a Vue app#

Create a Vue app using the npm init command.

1
npm init vue@latest my-app

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

Navigate to the Vue 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.

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

7. Create the Supabase client#

Create a /src/lib directory in your Vue app, create a file called supabaseClient.js and add the following code to initialize the Supabase client:

1
import { createClient } from '@supabase/supabase-js'
2
3
const supabaseUrl = import.meta.env.VITE_SUPABASE_URL
4
const supabasePublishableKey = import.meta.env.VITE_SUPABASE_PUBLISHABLE_KEY
5
6
export const supabase = createClient(supabaseUrl, supabasePublishableKey)

8. Query data from the app#

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

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

9. Start the app#

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

1
npm run dev