mirror of
https://github.com/supabase/supabase.git
synced 2026-10-16 06:39:09 +03:00
Partials are currently defined via MDX includes. This PR switches to pre-compile-time partials, which have a new syntax: ``` <$Partial path="path/to/file.mdx" /> ``` ## Rationale This produces two improvements: 1. Partial substitution can occur in pipelines that don't use MDX compilation. For example, we can now do partial substitution before building the search index, so partial content will also be indexed. 2. After the App Router migration, the MDXProviders should've been deprecated, but were kept around for the sole reason of making partials work, and leading to us shipping unnecessary client-side code. We get a minor decrease in overall client bundle size (5.74 MB to 5.6 MB) by getting rid of the Providers. ## Breaking changes Besides the change to partial syntax, the arguments are also less powerful than before because we are doing string substitution and don't have the full power of JS. Defining string variables is still possible (documented in the Contributing guide), and since that's all we actually do in practice, this shouldn't be too cumbersome. There is always the escape hatch of making a custom component for more complex content reuse cases.
438 lines
11 KiB
Plaintext
438 lines
11 KiB
Plaintext
---
|
|
title: 'Build a User Management App with Nuxt 3'
|
|
description: 'Learn how to use Supabase in your Nuxt 3 App.'
|
|
---
|
|
|
|
<$Partial path="quickstart_intro.mdx" />
|
|
|
|

|
|
|
|
<Admonition type="note">
|
|
|
|
If you get stuck while working through this guide, refer to the [full example on GitHub](https://github.com/supabase/supabase/tree/master/examples/user-management/nuxt3-user-management).
|
|
|
|
</Admonition>
|
|
|
|
<$Partial path="project_setup.mdx" />
|
|
|
|
## Building the app
|
|
|
|
Let's start building the Vue 3 app from scratch.
|
|
|
|
### Initialize a Nuxt 3 app
|
|
|
|
We can use [`nuxi init`](https://nuxt.com/docs/getting-started/installation) to create an app called `nuxt-user-management`:
|
|
|
|
```bash
|
|
npx nuxi init nuxt-user-management
|
|
|
|
cd nuxt-user-management
|
|
```
|
|
|
|
Then let's install the only additional dependency: [Nuxt Supabase](https://supabase.nuxtjs.org/). We only need to import Nuxt Supabase as a dev dependency.
|
|
|
|
```bash
|
|
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](#get-the-api-keys).
|
|
|
|
```bash .env
|
|
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](/docs/guides/auth#row-level-security) enabled on our Database.
|
|
Amazing thing about [Nuxt Supabase](https://supabase.nuxtjs.org/) 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](https://github.com/supabase-community/nuxt3-quickstarter/blob/main/assets/main.css).
|
|
|
|
```typescript nuxt.config.ts
|
|
import { defineNuxtConfig } from 'nuxt'
|
|
|
|
// https://v3.nuxtjs.org/api/configuration/nuxt.config
|
|
export 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.
|
|
|
|
```vue /components/Auth.vue
|
|
<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`](https://supabase.nuxtjs.org/usage/composables/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`.
|
|
|
|
```vue components/Account.vue
|
|
<script setup>
|
|
const supabase = useSupabaseClient()
|
|
|
|
const loading = ref(true)
|
|
const username = ref('')
|
|
const website = ref('')
|
|
const avatar_path = ref('')
|
|
|
|
loading.value = true
|
|
const 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 = false
|
|
|
|
async 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`:
|
|
|
|
```vue app.vue
|
|
<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:
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
And then open the browser to [localhost:3000](http://localhost:3000) and you should see the completed app.
|
|
|
|

|
|
|
|
## Bonus: Profile photos
|
|
|
|
Every Supabase project is configured with [Storage](/docs/guides/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:
|
|
|
|
```vue components/Avatar.vue
|
|
<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:
|
|
|
|
```vue components/Account.vue
|
|
<script setup>
|
|
const supabase = useSupabaseClient()
|
|
|
|
const loading = ref(true)
|
|
const username = ref('')
|
|
const website = ref('')
|
|
const avatar_path = ref('')
|
|
|
|
loading.value = true
|
|
const 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 = false
|
|
|
|
async 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.
|