Use Supabase with Nuxt

1. Create a Supabase project#

To start, you need a Supabase project.

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

Do these steps within your project's dashboard by copying and running the snippet in your project's SQL Editor.

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

3. Create a Nuxt app#

Create a Nuxt app using the npx nuxi command.

1
npx nuxi@latest init my-app

1
npx nuxi@latest init my-app --template minimal --no-gitInit --packageManager npm

4. Set up AI tooling (optional)#

Supabase provides two ways to give AI tools context about your project: Agent Skills, which give your AI coding agent procedural knowledge, and the MCP server, which connects AI assistants to your Supabase project directly.

Agent Skills#

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.

Installing Agent Skills#

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

1
npx skills add supabase/agent-skills

Supabase MCP server#

The Supabase MCP server connects AI assistants to Supabase, so they can inspect your schema and act on your projects on your behalf. Find out how to add it to your client in the MCP docs.

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.

1
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:

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

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.

7. Create the Supabase client#

Create a composable at app/composables/useSupabase.ts that builds the client from your config values. useRuntimeConfig() is only available inside a Nuxt context, such as a composable or a component's setup, so the client is created there rather than at the top level of a module. Nuxt auto-imports anything in app/composables/, so you don't need to import useSupabase where you use it.

1
import { createClient } from '@supabase/supabase-js'
2
3
export function useSupabase() {
4
  const config = useRuntimeConfig()
5
  return createClient(config.public.supabaseUrl, config.public.supabasePublishableKey)
6
}

8. Query data from the app#

In app/app.vue, replace the existing content with the following code.

1
<script setup>
2
const supabase = useSupabase()
3
const instruments = ref([])
4
const error = ref(null)
5
6
async function getInstruments() {
7
  const { data, error: fetchError } = await supabase.from('instruments').select()
8
9
  if (fetchError) {
10
    error.value = fetchError
11
    return
12
  }
13
14
  instruments.value = data
15
}
16
17
onMounted(() => {
18
  getInstruments()
19
})
20
</script>
21
22
<template>
23
  <p v-if="error">Error loading instruments: {{ error.message }}</p>
24
  <ul v-else>
25
    <li v-for="instrument in instruments" :key="instrument.id">{{ instrument.name }}</li>
26
  </ul>
27
</template>

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

Production requirements#

The quickstart procedure in this guide optimizes for getting you to a working app, not for production.

Before you deploy:

• If your app reads or writes through the Data API, review your Row Level Security policies. Any policy you added here is scoped to this quickstart's sample data, not to real user data.
• Set your Supabase credentials as environment variables on whatever platform you deploy to, rather than committing them to source control.
• Configure a custom domain for your Supabase project once you're ready to go live.

Next steps#

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