Getting Started

Build a User Management App with Ionic React

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 React app from scratch.

Initialize an Ionic React app

We can use the Ionic CLI to initialize an app called supabase-ionic-react:

1
2
3
npm install -g @ionic/cliionic start supabase-ionic-react blank --type reactcd supabase-ionic-react

Then let's install the only additional dependency: supabase-js

1
npm install @supabase/supabase-js

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
REACT_APP_SUPABASE_URL=YOUR_SUPABASE_URLREACT_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.

1
2
3
4
5
6
import { createClient } from '@supabase/supabase-js'const supabaseUrl = process.env.REACT_APP_SUPABASE_URLconst supabaseAnonKey = process.env.REACT_APP_SUPABASE_ANON_KEYexport const supabase = createClient(supabaseUrl, supabaseAnonKey)

Set up a login route

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.

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
import { useState } from 'react';import {  IonButton,  IonContent,  IonHeader,  IonInput,  IonItem,  IonLabel,  IonList,  IonPage,  IonTitle,  IonToolbar,  useIonToast,  useIonLoading,} from '@ionic/react';import { supabase } from '../supabaseClient';export function LoginPage() {  const [email, setEmail] = useState('');  const [showLoading, hideLoading] = useIonLoading();  const [showToast ] = useIonToast();  const handleLogin = async (e: React.FormEvent<HTMLFormElement>) => {    console.log()    e.preventDefault();    await showLoading();    try {      await supabase.auth.signIn({ email });      await showToast({ message: 'Check your email for the login link!' });    } catch (e: any) {      await showToast({ message: e.error_description || e.message , duration: 5000});    } finally {      await hideLoading();    }  };  return (    <IonPage>      <IonHeader>        <IonToolbar>          <IonTitle>Login</IonTitle>        </IonToolbar>      </IonHeader>      <IonContent>        <div className="ion-padding">          <h1>Supabase + Ionic React</h1>          <p>Sign in via magic link with your email below</p>        </div>        <IonList inset={true}>          <form onSubmit={handleLogin}>            <IonItem>              <IonLabel position="stacked">Email</IonLabel>              <IonInput                value={email}                name="email"                onIonChange={(e) => setEmail(e.detail.value ?? '')}                type="email"              ></IonInput>            </IonItem>            <div className="ion-text-center">              <IonButton type="submit" fill="clear">                Login              </IonButton>            </div>          </form>        </IonList>      </IonContent>    </IonPage>  );}

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

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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
import {  IonButton,  IonContent,  IonHeader,  IonInput,  IonItem,  IonLabel,  IonPage,  IonTitle,  IonToolbar,  useIonLoading,  useIonToast,  useIonRouter} from '@ionic/react';import { useEffect, useState } from 'react';import { supabase } from '../supabaseClient';export function AccountPage() {  const [showLoading, hideLoading] = useIonLoading();  const [showToast] = useIonToast();  const [session] = useState(() => supabase.auth.session());  const router = useIonRouter();  const [profile, setProfile] = useState({    username: '',    website: '',    avatar_url: '',  });  useEffect(() => {    getProfile();  }, [session]);  const getProfile = async () => {    console.log('get');    await showLoading();    try {      const user = supabase.auth.user();      const { 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) {        setProfile({          username: data.username,          website: data.website,          avatar_url: data.avatar_url,        });      }    } catch (error: any) {      showToast({ message: error.message, duration: 5000 });    } finally {      await hideLoading();    }  };  const signOut = async () => {    await supabase.auth.signOut();    router.push('/', 'forward', 'replace');  }  const updateProfile = async (e?: any, avatar_url: string = '') => {    e?.preventDefault();    console.log('update ');    await showLoading();    try {      const user = supabase.auth.user();      const updates = {        id: user!.id,        ...profile,        avatar_url: avatar_url,        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: any) {      showToast({ message: error.message, duration: 5000 });    } finally {      await hideLoading();    }  };  return (    <IonPage>      <IonHeader>        <IonToolbar>          <IonTitle>Account</IonTitle>        </IonToolbar>      </IonHeader>      <IonContent>        <form onSubmit={updateProfile}>          <IonItem>            <IonLabel>              <p>Email</p>              <p>{session?.user?.email}</p>            </IonLabel>          </IonItem>          <IonItem>            <IonLabel position="stacked">Name</IonLabel>            <IonInput              type="text"              name="username"              value={profile.username}              onIonChange={(e) =>                setProfile({ ...profile, username: e.detail.value ?? '' })              }            ></IonInput>          </IonItem>          <IonItem>            <IonLabel position="stacked">Website</IonLabel>            <IonInput              type="url"              name="website"              value={profile.website}              onIonChange={(e) =>                setProfile({ ...profile, website: e.detail.value ?? '' })              }            ></IonInput>          </IonItem>          <div className="ion-text-center">            <IonButton fill="clear" type="submit">              Update Profile            </IonButton>          </div>        </form>        <div className="ion-text-center">          <IonButton fill="clear" onClick={signOut}>            Log Out          </IonButton>        </div>      </IonContent>    </IonPage>  );}

Launch!

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

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
import { Redirect, Route } from 'react-router-dom'import { IonApp, IonRouterOutlet, setupIonicReact } from '@ionic/react'import { IonReactRouter } from '@ionic/react-router'import { supabase } from './supabaseClient'import '@ionic/react/css/ionic.bundle.css'/* Theme variables */import './theme/variables.css'import { LoginPage } from './pages/Login'import { AccountPage } from './pages/Account'import { useEffect, useState } from 'react'import { Session } from '@supabase/supabase-js'setupIonicReact()const App: React.FC = () => {  const [session, setSession] = useState < Session > null  useEffect(() => {    setSession(supabase.auth.session())    supabase.auth.onAuthStateChange((_event, session) => {      setSession(session)    })  }, [])  return (    <IonApp>      <IonReactRouter>        <IonRouterOutlet>          <Route            exact            path="/"            render={() => {              return session ? <Redirect to="/account" /> : <LoginPage />            }}          />          <Route exact path="/account">            <AccountPage />          </Route>        </IonRouterOutlet>      </IonReactRouter>    </IonApp>  )}export default App

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

1
ionic serve

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

Supabase Ionic React

Bonus: Profile photos

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

Create an upload widget

First install two packages in order to interact with the user's camera.

1
npm install @ionic/pwa-elements @capacitor/camera

Capacitor is a cross platform native runtime from Ionic that enables web apps to be deployed through the app store and provides access to native device API.

Ionic PWA elements is a companion package that will polyfill certain browser APIs that provide no user interface with custom Ionic UI.

With those packages installed we can update our index.tsx to include an additional bootstrapping call for the Ionic PWA Elements.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
import React from 'react'import ReactDOM from 'react-dom'import App from './App'import * as serviceWorkerRegistration from './serviceWorkerRegistration'import reportWebVitals from './reportWebVitals'import { defineCustomElements } from '@ionic/pwa-elements/loader'defineCustomElements(window)ReactDOM.render(  <React.StrictMode>    <App />  </React.StrictMode>,  document.getElementById('root'))serviceWorkerRegistration.unregister()reportWebVitals()

Then create an AvatarComponent.

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
import { IonIcon } from '@ionic/react';import { person } from 'ionicons/icons';import { Camera, CameraResultType } from '@capacitor/camera';import { useEffect, useState } from 'react';import { supabase } from '../supabaseClient';import './Avatar.css'export function Avatar({  url,  onUpload,}: {  url: string;  onUpload: (e: any, file: string) => Promise<void>;}) {  const [avatarUrl, setAvatarUrl] = useState<string | undefined>();  useEffect(() => {    if (url) {      downloadImage(url);    }  }, [url]);  const uploadAvatar = async () => {    try {      const photo = await Camera.getPhoto({        resultType: CameraResultType.DataUrl,      });      const file = await fetch(photo.dataUrl!)        .then((res) => res.blob())        .then(          (blob) =>            new File([blob], 'my-file', { type: `image/${photo.format}` })        );      const fileName = `${Math.random()}-${new Date().getTime()}.${        photo.format      }`;      const { error: uploadError } = await supabase.storage        .from('avatars')        .upload(fileName, file);      if (uploadError) {        throw uploadError;      }      onUpload(null, fileName);    } catch (error) {      console.log(error);    }  };  const downloadImage = async (path: string) => {    try {      const { data, error } = await supabase.storage        .from('avatars')        .download(path);      if (error) {        throw error;      }      const url = URL.createObjectURL(data!);      setAvatarUrl(url);    } catch (error: any) {      console.log('Error downloading image: ', error.message);    }  };  return (    <div className="avatar">    <div className="avatar_wrapper" onClick={uploadAvatar}>      {avatarUrl ? (        <img src={avatarUrl} />      ) : (        <IonIcon icon={person} className="no-avatar" />      )}    </div>    </div>  );}

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
// Import the new componentimport { Avatar } from '../components/Avatar';// ...return (  <IonPage>    <IonHeader>      <IonToolbar>        <IonTitle>Account</IonTitle>      </IonToolbar>    </IonHeader>    <IonContent>      <Avatar url={profile.avatar_url} onUpload={updateProfile}></Avatar>

At this stage you have a fully functional application!