Skip to main content

Quickstart: Next.js


This example provides the steps to build a simple user management app (from scratch!) using Supabase and Next.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:

Supabase User Management example

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#

  1. Go to
  2. Click on "New Project".
  3. Enter your project details.
  4. 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" section.2. Click "User Management Starter".3. Click "Run".

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.

1. Go to the "Settings" section.2. Click "API" in the sidebar.3. Find your API URL in this page.4. Find your "anon" and "service_role" keys on this page.

Building the App#

Let's start building the Next.js app from scratch.

Initialize a Next.js app#

We can use create-next-app to initialize an app called supabase-nextjs:

npx create-next-app supabase-nextjscd supabase-nextjs

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.


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.

import { createClient } from '@supabase/supabase-js'
const supabaseUrl = process.env.NEXT_PUBLIC_SUPABASE_URLconst supabaseAnonKey = process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY
export const supabase = createClient(supabaseUrl, supabaseAnonKey)

And one optional step is to update the CSS file styles/globals.css to make the app look nice. You can find the full contents of this file here.

Set up a Login component#

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

import { useState } from 'react'import { supabase } from '../utils/supabaseClient'
export default function Auth() {  const [loading, setLoading] = useState(false)  const [email, setEmail] = useState('')
  const handleLogin = async (email) => {    try {      setLoading(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 {      setLoading(false)    }  }
  return (    <div className="row flex flex-center">      <div className="col-6 form-widget">        <h1 className="header">Supabase + Next.js</h1>        <p className="description">Sign in via magic link with your email below</p>        <div>          <input            className="inputField"            type="email"            placeholder="Your email"            value={email}            onChange={(e) => setEmail(}          />        </div>        <div>          <button            onClick={(e) => {              e.preventDefault()              handleLogin(email)            }}            className="button block"            disabled={loading}          >            <span>{loading ? 'Loading' : 'Send magic link'}</span>          </button>        </div>      </div>    </div>  )}

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

import { useState, useEffect } from 'react'import { supabase } from '../utils/supabaseClient'
export default function Account({ session }) {  const [loading, setLoading] = useState(true)  const [username, setUsername] = useState(null)  const [website, setWebsite] = useState(null)  const [avatar_url, setAvatarUrl] = useState(null)
  useEffect(() => {    getProfile()  }, [session])
  async function getProfile() {    try {      setLoading(true)      const user = supabase.auth.user()
      let { data, error, status } = await supabase        .from('profiles')        .select(`username, website, avatar_url`)        .eq('id',        .single()
      if (error && status !== 406) {        throw error      }
      if (data) {        setUsername(data.username)        setWebsite(        setAvatarUrl(data.avatar_url)      }    } catch (error) {      alert(error.message)    } finally {      setLoading(false)    }  }
  async function updateProfile({ username, website, avatar_url }) {    try {      setLoading(true)      const user = supabase.auth.user()
      const updates = {        id:,        username,        website,        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 {      setLoading(false)    }  }
  return (    <div className="form-widget">      <div>        <label htmlFor="email">Email</label>        <input id="email" type="text" value={} disabled />      </div>      <div>        <label htmlFor="username">Name</label>        <input          id="username"          type="text"          value={username || ''}          onChange={(e) => setUsername(}        />      </div>      <div>        <label htmlFor="website">Website</label>        <input          id="website"          type="website"          value={website || ''}          onChange={(e) => setWebsite(}        />      </div>
      <div>        <button          className="button block primary"          onClick={() => updateProfile({ username, website, avatar_url })}          disabled={loading}        >          {loading ? 'Loading ...' : 'Update'}        </button>      </div>
      <div>        <button className="button block" onClick={() => supabase.auth.signOut()}>          Sign Out        </button>      </div>    </div>  )}


Now that we have all the components in place, let's update pages/index.js:

import { useState, useEffect } from 'react'import { supabase } from '../utils/supabaseClient'import Auth from '../components/Auth'import Account from '../components/Account'
export default function Home() {  const [session, setSession] = useState(null)
  useEffect(() => {    setSession(supabase.auth.session())
    supabase.auth.onAuthStateChange((_event, session) => {      setSession(session)    })  }, [])
  return (    <div className="container" style={{ padding: '50px 0 100px 0' }}>      {!session ? <Auth /> : <Account key={} session={session} />}    </div>  )}

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

npm run dev

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

Supabase User demo

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:

import { useEffect, useState } from 'react'import { supabase } from '../utils/supabaseClient'
export default function Avatar({ url, size, onUpload }) {  const [avatarUrl, setAvatarUrl] = useState(null)  const [uploading, setUploading] = useState(false)
  useEffect(() => {    if (url) downloadImage(url)  }, [url])
  async function downloadImage(path) {    try {      const { data, error } = await'avatars').download(path)      if (error) {        throw error      }      const url = URL.createObjectURL(data)      setAvatarUrl(url)    } catch (error) {      console.log('Error downloading image: ', error.message)    }  }

  async function uploadAvatar(event) {    try {      setUploading(true)
      if (! || === 0) {        throw new Error('You must select an image to upload.')      }
      const file =[0]      const fileExt ='.').pop()      const fileName = `${Math.random()}.${fileExt}`      const filePath = `${fileName}`
      let { error: uploadError } = await        .from('avatars')        .upload(filePath, file)
      if (uploadError) {        throw uploadError      }
      onUpload(filePath)    } catch (error) {      alert(error.message)    } finally {      setUploading(false)    }  }
  return (    <div>      {avatarUrl ? (        <img          src={avatarUrl}          alt="Avatar"          className="avatar image"          style={{ height: size, width: size }}        />      ) : (        <div className="avatar no-image" style={{ height: size, width: size }} />      )}      <div style={{ width: size }}>        <label className="button primary block" htmlFor="single">          {uploading ? 'Uploading ...' : 'Upload'}        </label>        <input          style={{            visibility: 'hidden',            position: 'absolute',          }}          type="file"          id="single"          accept="image/*"          onChange={uploadAvatar}          disabled={uploading}        />      </div>    </div>  )}

Add the new widget#

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

// Import the new componentimport Avatar from './Avatar'
// ...
return (  <div className="form-widget">    {/* Add to the body */}    <Avatar      url={avatar_url}      size={150}      onUpload={(url) => {        setAvatarUrl(url)        updateProfile({ username, website, avatar_url: url })      }}    />    {/* ... */}  </div>)

Next steps#

At this stage you have a fully functional application!