About this guide
This development guide walks you through everything you need to do to build a high-quality Next.js app integrated with Supabase Auth, Supabase DB, and Material UI. Check out the tasks below to get started. To save time, you can also use our boilerplate, which gives you a complete React codebase with all of these tasks done for you. Okay, let's dive in!
Tasks
Setup your Next.js app
Create a Next.js app usingnpx create-next-app
and then run your project locally with thenpm run dev
command.Create a Supabase AuthProvider and useAuth hook
Create anAuthProvider
component that fetches the current user from Supabase, subscribes to changes, stores the user in state, and then makes all this data available to child components usingContext.Provider
. Make sure to update your Next.jsApp
component so thatAuthProvider
wraps all your pages. You'll then create auseAuth
hook that reads the user withuseContext
and returns its value. This will enable any component to calluseAuth
to get the current user and re-render when it changes.Create a Protect pages with a Supabase requireAuth HOC
requireAuth
higher order component for pages that should only be viewable by authenticated users. It should call youruseAuth
hook internally to get the current user, show a loading indicator while waiting on the response, and then either render the page or redirect to/signin
depending on whether the user is authenticated. For the loading indicator you might try aCircularProgress
component centered on the page.Build your authentication UI
Create an authentication UI using Material UI components and Supabase functions. You'll want routes for user sign-up, sign-in, forgot password, and change password. Make sure you properly validate inputs and display any errors returned by Supabase. You may also want to use a library, such as React Hook Form, for managing form state.Link user to analytics session
You can connect Google Analytics sessions to the current authenticated user with the User ID feature. This allows you to see what your users are doing across sessions and devices. You'll need to update youruseAuth
hook to set theuser_id
property whenever the user changes.Create Supabase query hooks
Create React hooks that wrap your Supabase queries, such asuseUser
,useItem
, anduseItemsByUser
. These hooks should fetch data and return a query status of "success", "loading", or "error". The React Query library makes it especially easy to setup these hooks and have components re-render when data changes.Create Supabase tables and policies
Create the database tables that your app requires. For a simple SaaS app you could start with tables forusers
,customers
anditems
. Yourcustomers
anditems
tables would generally have auser_id
column that referencesusers.id
. You can create these tables right in your Supabase dashboard, but we recommend writing acreate table
SQL snippet for each table, allowing you to easily recreate them in the future. Lastly, you'll want to enable Row Level Security for your tables and secure read/write access with policies.Setup a trigger to create user in database on signup
When a user signs up with Supabase Auth you'll want to automatically insert their data to theusers
table so that you can easily query on it. This can be accomplished with a trigger. Setup a trigger that inserts a new row into theusers
table when a user signs up. You'll also want to create a trigger that updates that data when a user's auth email changes. This ensures that your database is always in sync with user data in Supabase Auth.Build a data-driven UI
Create a data-driven UI using Material UI components that reads/writes data to Supabase. The specifics will depend on the type of app you're building, but we generally recommend having auseItemsByOwner
hook that fetches "items" in Supabase that are owned by the current user. You can then create a component for displaying that data in a simple list or table if more columns are needed. Finally, you'll want create a flow for creating and updating items utilizing Material UI modal and form components.Server render Material UI styles with Next.js
You'll need to server-render your Material UI styles to avoid a flash of unstyled content before your client-side javascript loads. To do this you'll need to update your Next.jsDocument
component to extract component styles. After mount you'll then remove the server stylesheet so that the client can take over with style management.Ensure Material UI link components hook into Next.js routing
Make all Material UI link components hook into Next.js routing by wrapping them with theLink
component fromnext/link
and settingpassHref
to true.Create a persistent layout
Add any components that you'd like displayed across all pages (such asNavbar
andFooter
) to your Next.jsApp
component. If you need multiple persistent layouts you can instead have each page define its own layout. In that case, create multiple layout components (such asLandingPageLayout
andAdminLayout
) and wrap the contents of each page.Add a Material UI ThemeProvider
Add the Material UIThemeProvider
component so that you customize theme values. If your entire app uses the same theme (as opposed to different nested themes), then the best way to do this is update your Next.jsApp
component so thatThemeProvider
wraps all your pages.To support Add dark mode supportdark mode you'll need to define a light and dark Material UI theme object, read the user's preference from local storage on mount, fall back to their browser default using
prefers-color-scheme
, and pass the correct theme object toThemeProvider
. You'll also want to create auseDarkMode
React hook that any component can call to get/toggle the user's preference. Be sure to check out our example Material UI components with dark mode toggle.Build out the rest of your UI using Material UI components and composing them into high-level page sections, such as Finish your app UI with Material UI
HeroSection
andAccountSettings
. Use Material UI's CSS-in-JS solution for styling your components and overriding default component styles. You should find our library of pre-built Material UI components to be helpful.
Get the code
You can get the code for this guide with our Next.js, Supabase Auth, Supabase DB, and Material UI Boilerplate. You'll get a complete Next.js codebase with Supabase Auth, Supabase DB, and Material UI integration, all the tasks listed above done for you, and a responsive multi-page template. It should save you about two weeks of development time.
127 downloads today