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

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 Nuxt app#

Create a Nuxt app using the npx nuxi command.

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

Navigate to the Nuxt 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 file and populate with your Supabase connection variables that you can get from the helper above, or from the project Connect panel:

1
SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>
2
SUPABASE_PUBLISHABLE_KEY=<SUBSTITUTE_SUPABASE_PUBLISHABLE_KEY>

6. Query data from the app#

In app.vue, create a Supabase client using your config values and replace the existing content with the following code.

app.vue
1
<script setup>
2
import { createClient } from '@supabase/supabase-js'
3
4
const config = useRuntimeConfig()
5
const supabase = createClient(config.public.supabaseUrl, config.public.supabasePublishableKey)
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>

7. Start the app#

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

1
npm run dev