Use Supabase with Nuxt

<$Partial path="quickstart_db_setup.mdx" />

3. Create a Nuxt app

Create a Nuxt app using the npx nuxi command.

npx nuxi@latest init my-app

4. Install Supabase's Agent Skills (optional)

Supabase's Agent Skills is a curated set of instructions that give your AI agent procedural knowledge about working with Supabase.

Install them so your AI coding agent can produce more accurate, reliable code using current Supabase patterns, such as authentication, server-side rendering, and database migrations, rather than relying solely on training data.

To install, run the following command in the root of your project:

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

Navigate to the Nuxt app and install supabase-js.

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

6. Declare Supabase environment variables

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

<$CodeTabs>

SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>
SUPABASE_PUBLISHABLE_KEY=<SUBSTITUTE_SUPABASE_PUBLISHABLE_KEY>

export default defineNuxtConfig({
  runtimeConfig: {
    public: {
      supabaseUrl: process.env.SUPABASE_URL,
      supabasePublishableKey: process.env.SUPABASE_PUBLISHABLE_KEY,
    },
  },
})

</$CodeTabs>

<$Partial path="api_settings.mdx" variables={{ "framework": "nuxt", "tab": "frameworks" }} />

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

<script setup>
import { createClient } from '@supabase/supabase-js'

const config = useRuntimeConfig()
const supabase = createClient(config.public.supabaseUrl, config.public.supabasePublishableKey)
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>

8. Start the app

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

npm run dev

The community-maintained @nuxtjs/supabase module provides an alternate DX for working with Supabase in Nuxt.

Next steps

• Explore drop-in UI components for your Supabase app
• Set up Auth for your app
• Insert more data into your database
• Upload and serve static files using Storage