Build a User Management App with React

Explore drop-in UI components for your Supabase app.

UI components built on shadcn/ui that connect to Supabase via a single command.

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 Database - a Postgres database for storing your user data and Row Level Security so data is protected and users can only access their own information.
Supabase Auth - allow users to sign up and log in.
Supabase Storage - allow users to upload a profile photo.

Supabase User Management example

If you get stuck while working through this guide, refer to the full example on GitHub.

Project setup#

Before you start building you need to set up the Database and API. You can do this by starting a new Project in Supabase and then creating a "schema" inside the database.

Create a project#

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

Set up the database schema#

Now set up the database schema. You can use the "User Management Starter" quickstart in the SQL Editor, or you can copy/paste the SQL from below and run it.

Go to the SQL Editor page in the Dashboard.
Click User Management Starter under the Community > Quickstarts tab.
Click Run.

You can pull the database schema down to your local project by running the db pull command. Read the local development docs for detailed instructions.

1
supabase link --project-ref <project-id>
2
# You can get <project-id> from your project's dashboard URL: https://supabase.com/dashboard/project/<project-id>
3
supabase db pull

Get API details#

Now that you've created some database tables, you are ready to insert data using the auto-generated API.

To do this, you need to get the Project URL and key from the project Connect dialog.

Changes to API keys

Supabase is changing the way keys work to improve project security and developer experience. You can read the full announcement, but in the transition period, you can use both the current anon and service_role keys and the new publishable key with the form sb_publishable_xxx which will replace the older keys.

In most cases, you can get the correct key from the Project's Connect dialog, but if you want a specific key, you can find all keys in the API Keys section of a Project's Settings page:

For legacy keys, copy the anon key for client-side operations and the service_role key for server-side operations from the Legacy API Keys tab.
For new keys, open the API Keys tab, if you don't have a publishable key already, click Create new API Keys, and copy the value from the Publishable key section.

Read the API keys docs for a full explanation of all key types and their uses.

Building the app#

Start building the React app from scratch.

Initialize a React app#

Use Vite to initialize an app called supabase-react:

1
npm create vite@latest supabase-react -- --template react
2
cd supabase-react

Install the only additional dependency: supabase-js.

1
npm install @supabase/supabase-js

And finally, save the environment variables in a .env.local file. Use the Project URL and the key that you copied earlier.

.env

1
VITE_SUPABASE_URL=
2
VITE_SUPABASE_PUBLISHABLE_DEFAULT_KEY=

View source

With the API credentials in place, create a helper file to initialize the Supabase client. These variables will be exposed on the browser, and that's fine as you have Row Level Security enabled on the Database.

Create and edit src/supabaseClient.js:

src/supabaseClient.js

1
/**
2
 * lib/supabaseClient.js
3
 * Helper to initialize the Supabase client.
4
 */
5
6
import { createClient } from '@supabase/supabase-js'
7
8
const supabaseUrl = import.meta.env.VITE_SUPABASE_URL
9
const supabasePublishableKey = import.meta.env.VITE_SUPABASE_PUBLISHABLE_DEFAULT_KEY
10
11
export const supabase = createClient(supabaseUrl, supabasePublishableKey)

View source

App styling (optional)#

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

Create a React component to manage logins and sign-ups. It uses Magic Links, so users can sign in with their email without using passwords.

Create and edit src/Auth.jsx:

src/Auth.jsx

1
import { useState } from 'react'
2
import { supabase } from './supabaseClient'
3
4
export default function Auth() {
5
  const [loading, setLoading] = useState(false)
6
  const [email, setEmail] = useState('')
7
8
  const handleLogin = async (event) => {
9
    event.preventDefault()
10
11
    setLoading(true)
12
    const { error } = await supabase.auth.signInWithOtp({ email })
13
14
    if (error) {
15
      alert(error.error_description || error.message)
16
    } else {
17
      alert('Check your email for the login link!')
18
    }
19
    setLoading(false)
20
  }
21
22
  return (
23
    <div className="row flex flex-center">
24
      <div className="col-6 form-widget">
25
        <h1 className="header">Supabase + React</h1>
26
        <p className="description">Sign in via magic link with your email below</p>
27
        <form className="form-widget" onSubmit={handleLogin}>
28
          <div>
29
            <input
30
              className="inputField"
31
              type="email"
32
              placeholder="Your email"
33
              value={email}
34
              required={true}
35
              onChange={(e) => setEmail(e.target.value)}
36
            />
37
          </div>
38
          <div>
39
            <button className={'button block'} disabled={loading}>
40
              {loading ? <span>Loading</span> : <span>Send magic link</span>}
41
            </button>
42
          </div>
43
        </form>
44
      </div>
45
    </div>
46
  )
47
}

View source

Account page#

Users also need a way to edit their profile details and manage their accounts after signing in.

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

Create an avatar for the user so that they can upload a profile photo. Start by creating a new component:

Create and edit src/Avatar.jsx:

src/Avatar.jsx

1
import { useEffect, useState } from 'react'
2
import { supabase } from './supabaseClient'
3
4
export default function Avatar({ url, size, onUpload }) {
5
  const [avatarUrl, setAvatarUrl] = useState(null)
6
  const [uploading, setUploading] = useState(false)
7
8
  useEffect(() => {
9
    if (url) downloadImage(url)
10
  }, [url])
11
12
  async function downloadImage(path) {
13
    try {
14
      const { data, error } = await supabase.storage.from('avatars').download(path)
15
      if (error) {
16
        throw error
17
      }
18
      const url = URL.createObjectURL(data)
19
      setAvatarUrl(url)
20
    } catch (error) {
21
      console.log('Error downloading image: ', error.message)
22
    }
23
  }
24
25
  async function uploadAvatar(event) {
26
    try {
27
      setUploading(true)
28
29
      if (!event.target.files || event.target.files.length === 0) {
30
        throw new Error('You must select an image to upload.')
31
      }
32
33
      const file = event.target.files[0]
34
      const fileExt = file.name.split('.').pop()
35
      const fileName = `${Math.random()}.${fileExt}`
36
      const filePath = `${fileName}`
37
38
      let { error: uploadError } = await supabase.storage.from('avatars').upload(filePath, file)
39
40
      if (uploadError) {
41
        throw uploadError
42
      }
43
44
      onUpload(event, filePath)
45
    } catch (error) {
46
      alert(error.message)
47
    } finally {
48
      setUploading(false)
49
    }
50
  }
51
52
  return (
53
    <div>
54
      {avatarUrl ? (
55
        <img
56
          src={avatarUrl}
57
          alt="Avatar"
58
          className="avatar image"
59
          style={{ height: size, width: size }}
60
        />
61
      ) : (
62
        <div className="avatar no-image" style={{ height: size, width: size }} />
63
      )}
64
      <div style={{ width: size }}>
65
        <label className="button primary block" htmlFor="single">
66
          {uploading ? 'Uploading ...' : 'Upload'}
67
        </label>
68
        <input
69
          style={{
70
            visibility: 'hidden',
71
            position: 'absolute',
72
          }}
73
          type="file"
74
          id="single"
75
          accept="image/*"
76
          onChange={uploadAvatar}
77
          disabled={uploading}
78
        />
79
      </div>
80
    </div>
81
  )
82
}

View source

After a user is signed in, allow them to edit their profile details and manage their account.

Create a new component for that called src/Account.jsx and also add the Avatar component created earlier.

src/Account.jsx

1
import { useState, useEffect } from 'react'
2
import { supabase } from './supabaseClient'
3
import Avatar from './Avatar'
4
5
export default function Account({ user }) {
6
  const [loading, setLoading] = useState(true)
7
  const [username, setUsername] = useState(null)
8
  const [website, setWebsite] = useState(null)
9
  const [avatar_url, setAvatarUrl] = useState(null)
10
11
  useEffect(() => {
12
    let ignore = false
13
    async function getProfile() {
14
      setLoading(true)
15
16
      const { data, error } = await supabase
17
        .from('profiles')
18
        .select(`username, website, avatar_url`)
19
        .eq('id', user.id)
20
        .single()
21
22
      if (!ignore) {
23
        if (error) {
24
          console.warn(error)
25
        } else if (data) {
26
          setUsername(data.username)
27
          setWebsite(data.website)
28
          setAvatarUrl(data.avatar_url)
29
        }
30
      }
31
32
      setLoading(false)
33
    }
34
35
    getProfile()
36
37
    return () => {
38
      ignore = true
39
    }
40
  }, [user])
41
42
  async function updateProfile(event, avatarUrl) {
43
    event.preventDefault()
44
45
    setLoading(true)
46
47
    const updates = {
48
      id: user.id,
49
      username,
50
      website,
51
      avatar_url: avatarUrl,
52
      updated_at: new Date(),
53
    }
54
55
    const { error } = await supabase.from('profiles').upsert(updates)
56
57
    if (error) {
58
      alert(error.message)
59
    } else {
60
      setAvatarUrl(avatarUrl)
61
    }
62
    setLoading(false)
63
  }
64
65
  return (
66
    <form onSubmit={updateProfile} className="form-widget">
67
      <Avatar
68
        url={avatar_url}
69
        size={150}
70
        onUpload={(event, url) => {
71
          updateProfile(event, url)
72
        }}
73
      />
74
      <div>
75
        <label htmlFor="email">Email</label>
76
        <input id="email" type="text" value={user.email} disabled />
77
      </div>
78
      <div>
79
        <label htmlFor="username">Name</label>
80
        <input
81
          id="username"
82
          type="text"
83
          required
84
          value={username || ''}
85
          onChange={(e) => setUsername(e.target.value)}
86
        />
87
      </div>
88
      <div>
89
        <label htmlFor="website">Website</label>
90
        <input
91
          id="website"
92
          type="url"
93
          value={website || ''}
94
          onChange={(e) => setWebsite(e.target.value)}
95
        />
96
      </div>
97
98
      <div>
99
        <button className="button block primary" type="submit" disabled={loading}>
100
          {loading ? 'Loading ...' : 'Update'}
101
        </button>
102
      </div>
103
104
      <div>
105
        <button className="button block" type="button" onClick={() => supabase.auth.signOut()}>
106
          Sign Out
107
        </button>
108
      </div>
109
    </form>
110
  )
111
}

View source

Launch!#

Now that you have all the components in place, update src/App.jsx, which fetches the current user via the getUser method if there is an existing session. This method performs a network request to the Supabase Auth server.

src/App.jsx

1
import { useState, useEffect } from 'react'
2
import './App.css'
3
import { supabase } from './supabaseClient'
4
import Auth from './Auth'
5
import Account from './Account'
6
7
function App() {
8
  const [user, setUser] = useState(null)
9
10
  useEffect(() => {
11
    supabase.auth.getUser().then(({ data: { user } }) => {
12
      setUser(user)
13
    })
14
15
    supabase.auth.onAuthStateChange(async () => {
16
      const { data: { user } } = await supabase.auth.getUser()
17
      setUser(user)
18
    })
19
  }, [])
20
21
  return (
22
    <div className="container" style={{ padding: '50px 0 100px 0' }}>
23
      {!user ? <Auth /> : <Account key={user.id} user={user} />}
24
    </div>
25
  )
26
}
27
28
export default App

View source

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

1
npm run dev

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

Supabase React

At this stage you have a fully functional application!

Build a User Management App with React

Explore drop-in UI components for your Supabase app.

Project setup#

Create a project#

Set up the database schema#

Get API details#

Changes to API keys

Building the app#

Initialize a React app#

.env

src/supabaseClient.js

App styling (optional)#

src/Auth.jsx

Account page#

Create an upload widget#

src/Avatar.jsx

src/Account.jsx

Launch!#

src/App.jsx

Is this helpful?

Build a User Management App with React

Explore drop-in UI components for your Supabase app.

Project setup#

Create a project#

Set up the database schema#

Get API details#

Changes to API keys

Building the app#

Initialize a React app#

.env

src/supabaseClient.js

App styling (optional)#

Set up a login component#

src/Auth.jsx

Account page#

Create an upload widget#

src/Avatar.jsx

src/Account.jsx

Launch!#

src/App.jsx

Is this helpful?