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.

Alternatively, you can create a project using the Management API:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# First, get your access token from https://supabase.com/dashboard/account/tokensexport SUPABASE_ACCESS_TOKEN="your-access-token"# List your organizations to get the organization IDcurl -H "Authorization: Bearer $SUPABASE_ACCESS_TOKEN" \  https://api.supabase.com/v1/organizations# Create a new project (replace <org-id> with your organization ID)curl -X POST https://api.supabase.com/v1/projects \  -H "Authorization: Bearer $SUPABASE_ACCESS_TOKEN" \  -H "Content-Type: application/json" \  -d '{    "organization_id": "<org-id>",    "name": "My Project",    "region": "us-east-1",    "db_pass": "<your-secure-password>"  }'

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.

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

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

Declare Supabase Environment Variables

Create a .env file and populate with your Supabase connection variables:

Project URL
Anon key
1
2
SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>SUPABASE_ANON_KEY=<SUBSTITUTE_SUPABASE_ANON_KEY>
5

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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<script setup>import { createClient } from '@supabase/supabase-js'const config = useRuntimeConfig()const supabase = createClient(config.public.supabaseUrl, config.public.supabaseAnonKey)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>
6

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.

Terminal
1
npm run dev