Getting Started

Build a User Management App with Nuxt 3

This tutorial demonstrates how to build a basic user management app. The app authenticates and identifies the user, stores their profile information in the database, and allows the user to log in, update their profile details, and upload a profile photo. The app uses:

Supabase User Management example

Project setup

Before we start building we're going to set up our Database and API. This is as simple as starting a new Project in Supabase and then creating a "schema" inside the database.

Create a project

  1. Create a new project in the Supabase Dashboard.
  2. Enter your project details.
  3. Wait for the new database to launch.

Set up the database schema

Now we are going to set up the database schema. We can use the "User Management Starter" quickstart in the SQL Editor, or you can just copy/paste the SQL from below and run it yourself.

  1. Go to the SQL Editor page in the Dashboard.
  2. Click User Management Starter.
  3. Click Run.
1
2
3
supabase link --project-ref <project-id># You can get <project-id> from your project's dashboard URL: https://supabase.com/dashboard/project/<project-id>supabase db pull

Get the API keys

Now that you've created some database tables, you are ready to insert data using the auto-generated API. We just need to get the Project URL and anon key from the API settings.

  1. Go to the API Settings page in the Dashboard.
  2. Find your Project URL, anon, and service_role keys on this page.

Building the app

Let's start building the Vue 3 app from scratch.

Initialize a Nuxt 3 app

We can use nuxi init to create an app called nuxt-user-management:

1
2
3
npx nuxi init nuxt-user-managementcd nuxt-user-management

Then let's install the only additional dependency: Nuxt Supabase. We only need to import Nuxt Supabase as a dev dependency.

1
npm install @nuxtjs/supabase --save-dev

And finally we want to save the environment variables in a .env. All we need are the API URL and the anon key that you copied earlier.

1
2
SUPABASE_URL="YOUR_SUPABASE_URL"SUPABASE_KEY="YOUR_SUPABASE_ANON_KEY"

These variables will be exposed on the browser, and that's completely fine since we have Row Level Security enabled on our Database. Amazing thing about Nuxt Supabase is that setting environment variables is all we need to do in order to start using Supabase. No need to initialize Supabase. The library will take care of it automatically.

App styling (optional)

An optional step is to update the CSS file assets/main.css to make the app look nice. You can find the full contents of this file here.

1
2
3
4
5
6
7
import { defineNuxtConfig } from 'nuxt'// https://v3.nuxtjs.org/api/configuration/nuxt.configexport default defineNuxtConfig({  modules: ['@nuxtjs/supabase'],  css: ['@/assets/main.css'],})

Set up Auth component

Let's set up a Vue component to manage logins and sign ups. We'll use Magic Links, so users can sign in with their email without using passwords.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
<script setup>const supabase = useSupabaseClient()const loading = ref(false)const email = ref('')const handleLogin = async () => {  try {    loading.value = true    const { error } = await supabase.auth.signInWithOtp({ email: email.value })    if (error) throw error    alert('Check your email for the login link!')  } catch (error) {    alert(error.error_description || error.message)  } finally {    loading.value = false  }}</script><template>  <form class="row flex-center flex" @submit.prevent="handleLogin">    <div class="col-6 form-widget">      <h1 class="header">Supabase + Nuxt 3</h1>      <p class="description">Sign in via magic link with your email below</p>      <div>        <input class="inputField" type="email" placeholder="Your email" v-model="email" />      </div>      <div>        <input          type="submit"          class="button block"          :value="loading ? 'Loading' : 'Send magic link'"          :disabled="loading"        />      </div>    </div>  </form></template>

User state

To access the user information, use the composable useSupabaseUser provided by the Supabase Nuxt module.

Account component

After a user is signed in we can allow them to edit their profile details and manage their account. Let's create a new component for that called Account.vue.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
<script setup>const supabase = useSupabaseClient()const loading = ref(true)const username = ref('')const website = ref('')const avatar_path = ref('')loading.value = trueconst user = useSupabaseUser()const { data } = await supabase  .from('profiles')  .select(`username, website, avatar_url`)  .eq('id', user.value.id)  .single()if (data) {  username.value = data.username  website.value = data.website  avatar_path.value = data.avatar_url}loading.value = falseasync function updateProfile() {  try {    loading.value = true    const user = useSupabaseUser()    const updates = {      id: user.value.id,      username: username.value,      website: website.value,      avatar_url: avatar_path.value,      updated_at: new Date(),    }    const { error } = await supabase.from('profiles').upsert(updates, {      returning: 'minimal', // Don't return the value after inserting    })    if (error) throw error  } catch (error) {    alert(error.message)  } finally {    loading.value = false  }}async function signOut() {  try {    loading.value = true    const { error } = await supabase.auth.signOut()    if (error) throw error    user.value = null  } catch (error) {    alert(error.message)  } finally {    loading.value = false  }}</script><template>  <form class="form-widget" @submit.prevent="updateProfile">    <div>      <label for="email">Email</label>      <input id="email" type="text" :value="user.email" disabled />    </div>    <div>      <label for="username">Username</label>      <input id="username" type="text" v-model="username" />    </div>    <div>      <label for="website">Website</label>      <input id="website" type="url" v-model="website" />    </div>    <div>      <input        type="submit"        class="button primary block"        :value="loading ? 'Loading ...' : 'Update'"        :disabled="loading"      />    </div>    <div>      <button class="button block" @click="signOut" :disabled="loading">Sign Out</button>    </div>  </form></template>

Launch!

Now that we have all the components in place, let's update app.vue:

1
2
3
4
5
6
7
8
9
10
<script setup>const user = useSupabaseUser()</script><template>  <div class="container" style="padding: 50px 0 100px 0">    <Account v-if="user" />    <Auth v-else />  </div></template>

Once that's done, run this in a terminal window:

1
npm run dev

And then open the browser to localhost:3000 and you should see the completed app.

Supabase Nuxt 3

Bonus: Profile photos

Every Supabase project is configured with Storage for managing large files like photos and videos.

Create an upload widget

Let's create an avatar for the user so that they can upload a profile photo. We can start by creating a new component:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
<script setup>const props = defineProps(['path'])const { path } = toRefs(props)const emit = defineEmits(['update:path', 'upload'])const supabase = useSupabaseClient()const uploading = ref(false)const src = ref('')const files = ref()const downloadImage = async () => {  try {    const { data, error } = await supabase.storage.from('avatars').download(path.value)    if (error) throw error    src.value = URL.createObjectURL(data)  } catch (error) {    console.error('Error downloading image: ', error.message)  }}const uploadAvatar = async (evt) => {  files.value = evt.target.files  try {    uploading.value = true    if (!files.value || files.value.length === 0) {      throw new Error('You must select an image to upload.')    }    const file = files.value[0]    const fileExt = file.name.split('.').pop()    const fileName = `${Math.random()}.${fileExt}`    const filePath = `${fileName}`    const { error: uploadError } = await supabase.storage.from('avatars').upload(filePath, file)    if (uploadError) throw uploadError    emit('update:path', filePath)    emit('upload')  } catch (error) {    alert(error.message)  } finally {    uploading.value = false  }}downloadImage()watch(path, () => {  if (path.value) {    downloadImage()  }})</script><template>  <div>    <img      v-if="src"      :src="src"      alt="Avatar"      class="avatar image"      style="width: 10em; height: 10em;"    />    <div v-else class="avatar no-image" :style="{ height: size, width: size }" />    <div style="width: 10em; position: relative;">      <label class="button primary block" for="single">        {{ uploading ? 'Uploading ...' : 'Upload' }}      </label>      <input        style="position: absolute; visibility: hidden;"        type="file"        id="single"        accept="image/*"        @change="uploadAvatar"        :disabled="uploading"      />    </div>  </div></template>

Add the new widget

And then we can add the widget to the Account page:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
<script setup>const supabase = useSupabaseClient()const loading = ref(true)const username = ref('')const website = ref('')const avatar_path = ref('')loading.value = trueconst user = useSupabaseUser()const { data } = await supabase  .from('profiles')  .select(`username, website, avatar_url`)  .eq('id', user.value.id)  .single()if (data) {  username.value = data.username  website.value = data.website  avatar_path.value = data.avatar_url}loading.value = falseasync function updateProfile() {  try {    loading.value = true    const user = useSupabaseUser()    const updates = {      id: user.value.id,      username: username.value,      website: website.value,      avatar_url: avatar_path.value,      updated_at: new Date(),    }    const { error } = await supabase.from('profiles').upsert(updates, {      returning: 'minimal', // Don't return the value after inserting    })    if (error) throw error  } catch (error) {    alert(error.message)  } finally {    loading.value = false  }}async function signOut() {  try {    loading.value = true    const { error } = await supabase.auth.signOut()    if (error) throw error  } catch (error) {    alert(error.message)  } finally {    loading.value = false  }}</script><template>  <form class="form-widget" @submit.prevent="updateProfile">    <Avatar v-model:path="avatar_path" @upload="updateProfile" />    <div>      <label for="email">Email</label>      <input id="email" type="text" :value="user.email" disabled />    </div>    <div>      <label for="username">Name</label>      <input id="username" type="text" v-model="username" />    </div>    <div>      <label for="website">Website</label>      <input id="website" type="url" v-model="website" />    </div>    <div>      <input        type="submit"        class="button primary block"        :value="loading ? 'Loading ...' : 'Update'"        :disabled="loading"      />    </div>    <div>      <button class="button block" @click="signOut" :disabled="loading">Sign Out</button>    </div>  </form></template>

That is it! You should now be able to upload a profile photo to Supabase Storage and you have a fully functional application.