This is based on the quickstart example(s) provided by supabase using React.js and Next.js
Just a reminder from the Supabase Documentation what exactly supabase is
Supabase is an open source Firebase alternative. We are a service to:
Listen to database changes.
- Query your tables, including filtering, pagination, and deeply nested relationships (like GraphQL).
- Create, update, and delete rows.
- Manage your users and their permissions.
- Interact with your database using a simple UI.
Intro
This example provides the steps to build a simple user management app (from scratch!) using Supabase and Vue.js. It includes:
- Supabase Database: a Postgres database for storing your user data.
- Supabase Auth: users can sign in with magic links (no passwords, only email).
- Supabase Storage: users can upload a photo.
- Row Level Security: data is protected so that individuals can only access their own data.
- Instant APIs: APIs will be automatically generated when you create your database tables. By the end of this guide you'll have an app which allows users to login and update some basic profile details:
Project Set up
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
- Go to app.supabase.io.
- Click on "New Project".
- Enter your project details.
- 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.
-- Create a table for public "profiles"
create table profiles (
id uuid references auth.users not null,
updated_at timestamp with time zone,
username text unique,
avatar_url text,
website text,
primary key (id),
unique(username),
constraint username_length check (char_length(username) >= 3)
);
alter table profiles enable row level security;
create policy "Public profiles are viewable by everyone."
on profiles for select
using ( true );
create policy "Users can insert their own profile."
on profiles for insert
with check ( auth.uid() = id );
create policy "Users can update own profile."
on profiles for update
using ( auth.uid() = id );
-- Set up Realtime!
begin;
drop publication if exists supabase_realtime;
create publication supabase_realtime;
commit;
alter publication supabase_realtime add table profiles;
-- Set up Storage!
insert into storage.buckets (id, name)
values ('avatars', 'avatars');
create policy "Avatar images are publicly accessible."
on storage.objects for select
using ( bucket_id = 'avatars' );
create policy "Anyone can upload an avatar."
on storage.objects for insert
with check ( bucket_id = 'avatars' );
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 URL and anon key from the API settings.
- Go to the "Settings" section.
- Click "API" in the sidebar.
- Find your API URL in this page.
- Find your "anon" and "service_role" keys on this page.
Building the App
Let's start building the Vue.js app from scratch.
Initialize a Vue App
We can use vue/cli to initialize an app called vue-user-management:
vue create vue-user-management
cd vue-user-management
Then let's install the only additional dependency: supabase-js
npm install @supabase/supabase-js
And finally we want to save the environment variables in a .env.local. All we need are the API URL and the anon key that you copied earlier.
.env.local
VUE_APP_SUPABASE_URL=YOUR_SUPABASE_URL
VUE_APP_SUPABASE_ANON_KEY=YOUR_SUPABASE_ANON_KEY
Now that we have the API credentials in place, let's create a helper file to initialize the Supabase client. These variables will be exposed on the browser, and that's completely fine since we have Row Level Security enabled on our Database.
/**
* lib/supabaseClient.js
* Helper to initialize the Supabase client.
*/
import { createClient } from '@supabase/supabase-js'
const supabaseUrl = process.env.VUE_APP_SUPABASE_URL
const supabaseAnonKey = process.env.VUE_APP_SUPABASE_ANON_KEY
export const supabase = createClient(supabaseUrl, supabaseAnonKey)
Set Up An 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. New component called Auth.vue
<template>
<div class="row flex flex-center">
<div class="col-6 form-widget">
<h1 class="header">Supabase + Vue.js</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>
<button
@click="
e => {
e.preventDefault();
handleLogin(email);
}
"
class="button block"
:disabled="loading"
>
<span>{{ loading ? "Loading..." : "Send Magic Link" }}</span>
</button>
</div>
</div>
</div>
</template>
<script lang="ts">
import { defineComponent, ref } from "vue";
import { supabase } from "./supabaseClient";
export default defineComponent({
name: "Auth",
setup() {
const loading = ref(false);
const email = ref("");
const handleLogin = async email => {
try {
loading.value = true;
const { error } = await supabase.auth.signIn({ email });
if (error) throw error;
alert("Check your email for the login link!");
} catch (error) {
alert(error.error_description || error.message);
} finally {
loading.value = false;
}
};
return {
email,
loading,
handleLogin
};
}
});
</script>
<style scoped>
</style>
Account Page
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.
<template>
<div class="form-widget">
<h1 class="header">Supabase + Vue.js: Account</h1>
<avatar :url="avatar_url" @onUpload="handleImageUpload" />
<div>
<label htmlFor="email">Email</label>
<input id="email" type="text" :value="session.user.email" disabled />
</div>
<div>
<label htmlFor="username">Name</label>
<input id="username" type="text" v-model="username" />
</div>
<div>
<label htmlFor="website">Website</label>
<input id="website" type="website" v-model="website" />
</div>
<div>
<button
class="button block primary"
@click="updateProfile({ username, website, avatar_url })"
:disabled="loading"
>
<span>{{ loading ? "Loading..." : "Update" }}</span>
</button>
</div>
<div>
<button class="button block" @click="supabase.auth.signOut()">
Sign Out
</button>
</div>
</div>
</template>
<script lang="ts">
import { defineComponent, ref } from "vue";
import Avatar from "./Avatar";
import { supabase } from "./supabaseClient";
export default defineComponent({
name: "Account",
props: ["session"],
components: {
Avatar
},
setup(props) {
const loading = ref(false);
const username = ref("");
const website = ref("");
const avatar_url = ref("");
/**
*
*/
const handleImageUpload = async path => {
avatar_url.value = path;
await updateProfile({ username, website, avatar_url: path });
};
const updateProfile = async ({ username, website, avatar_url }) => {
try {
debugger;
loading.value = true;
const user = supabase.auth.user();
const updates = {
id: user.id,
username : username.value,
website: website.value,
avatar_url: (avatar_url.value || avatar_url),
updated_at: new Date()
};
let { 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;
}
};
const getProfile = async session => {
try {
loading.value = true;
const user = session.user;
let { data, error, status } = await supabase
.from("profiles")
.select(`username, website, avatar_url`)
.eq("id", user.id)
.single();
if (error && status !== 406) {
throw error;
}
if (data) {
username.value = data.username;
website.value = data.website;
avatar_url.value = data.avatar_url;
}
debugger;
} catch (error) {
alert(error.message);
} finally {
loading.value = false;
}
};
getProfile(props.session);
return {
loading,
username,
website,
avatar_url,
updateProfile,
supabase,
handleImageUpload
};
}
});
</script>
<style scoped>
</style>
Bonus: Profile Photos
Every Supabase project is configured with Storage for managing large files like photos and videos.
Create an Avatar Component
Let's create an avatar for the user so that they can upload a profile photo and view an image associated with the user account. We can start by creating a new component: Avatar.vue
<template>
<img
:src="avatarUrl"
alt="Avatar"
class="avatar image"
style="height: 150px, width: 150px"
/>
<div style="width: 150px">
<input
style="visibility: hidden; position: absolute"
type="file"
id="single"
accept="image/*"
@change="uploadAvatar"
:disabled="uploading"
/>
<label class="button primary block" htmlFor="single">
<span>{{ uploading ? "UpLoading..." : "Upload" }}</span>
</label>
</div>
</template>
<script>
import { ref, watch } from "@vue/runtime-core";
import { supabase } from "./supabaseClient";
import missingImage from "@/assets/no_image_available.jpeg";
export default {
name: "Avatar",
props: {
url: String
},
emits: ["onUpload"],
setup(props, ctx) {
const avatarUrl = ref(null);
const uploading = ref(false);
watch(
() => props?.url,
(cur) => {
downloadImage(cur);
}
);
/**
*
*/
const downloadImage = async path => {
console.log("download path", path);
if (!path) {
avatarUrl.value = missingImage;
return;
}
const { data, error } = await supabase.storage
.from("avatars")
.download(path);
if (error) throw error;
avatarUrl.value = URL.createObjectURL(data);
};
async function uploadAvatar(event) {
debugger;
try {
uploading.value = true;
if (!event.target.files || event.target.files.length === 0) {
throw new Error("You must select an image to upload.");
}
const file = event.target.files[0];
const fileExt = file.name.split(".").pop();
const fileName = `${Math.random()}.${fileExt}`;
const filePath = `${fileName}`;
let { error: uploadError } = await supabase.storage
.from("avatars")
.upload(filePath, file);
if (uploadError) {
throw uploadError;
}
ctx.emit("onUpload", filePath);
} catch (error) {
alert(error.message);
} finally {
uploading.value = false;
}
}
return {
avatarUrl,
uploading,
uploadAvatar
};
}
};
</script>
<!-- Add "scoped" attribute to limit CSS to this component only -->
<style scoped>
</style>
App Component
here in the app component, we are tracking the session information to determine if we should render the Auth Component or the Account component.
When the App Component is mounted we check for a session and we also set up a listener to track for authentication state changes in the application to once again render the appropriate component.
<template>
<div className="container" style="padding: 50px 0 100px 0">
<template v-if="session">
<account :key="session.user.id" :session="session"/>
</template>
<template v-else><auth /></template>
</div>
</template>
<script lang="ts">
import { defineComponent, onMounted, ref } from "vue";
import Auth from "./Auth.vue";
import Account from "./Account.vue";
import { supabase } from "./supabaseClient";
export default defineComponent({
name: "App",
components: {
Auth,
Account
},
setup() {
const session = ref(null);
onMounted(() => {
session.value = supabase.auth.session();
supabase.auth.onAuthStateChange(() => {
session.value = supabase.auth.session();
console.log(session.value);
});
});
return {
session
};
}
});
</script>
<style>
</style>
Launch!
Now that we have all the components in place, let's update main.js:
import { createApp } from "vue";
import App from "./App.vue";
const app = createApp(App);
app.mount("#app");
Videos
See other Supabase VueJS Videos Here