About this guide
This development guide walks you through everything you need to do to build a high-quality React app integrated with Auth0, Cloud Firestore, and Stripe. 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 React app
Setup a React app usingnpx create-react-app
and routing using React Router. There are many ways you can structure your app, but a common setup is to have anApp
component that defines top-level routes, with each route component imported from the/pages
directory. The rest of your components should be located in your/components
directory. You can then run your app locally with thenpm run start
command.Setup a Node (Express.js) server
This stack requires server logic, so we'll be setting up a Node (Express.js) server that we can query from our React front-end. We suggest defining your Express.js routes in a file located at/api/index.js
and then creating a file for each route handler in the/api
directory. Next make sure all requests to/api/*
get routed to your Express server port by defining a proxy in yourpackage.json
. Lastly, run your server with thenode api
command in a new terminal window.Extend the Auth0 library
Create a file that wraps theauth0-js
library and abstracts away the storage and retrieval of the user's access token. Auth functions, such asauth0.signupAndAuthorize()
andauth0.client.login()
, should store the access token in memory or local storage after executing. Add a function calledgetCurrentUser()
that fetches the current user by passing the stored access token toauth0.client.userInfo()
. Our auth logic in subsequent tasks can call this function to get the current user.Create an Auth0 AuthProvider and useAuth hook
Create anAuthProvider
component that fetches the current user from Auth0, subscribes to changes, stores the user in state, and then makes all this data available to child components usingContext.Provider
. Make sure to update yourApp
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 an Auth0 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.Update the Merge extra user data from Cloud Firestore
useAuth
React hook to automatically fetch extra user data from the Cloud Firestoreusers
collection and merge it into the returned user object. This makes it easy to access extra user data (think username, subscription plan, etc) without needing to manage extra queries and loading states. Make sure to return anundefined
user object while the query is pending so that the user isn't considered logged in until all data is ready.Build your authentication UI
Create an authentication UI using your component library of choice and Auth0 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 Auth0. 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.Enable Auth0 email and password updating
To allow users to update their email and password you'll need to setup an API endpoint. Create an Express.js route at/api/auth-user
that uses theauth0
library and callsAuth0.ManagementClient.updateUser()
to change this info. Make sure thatAuth0.ManagementClient
is instantiated with the credentials for a "Machine to Machine" app, instead of your client-side app credentials. You can then create anupdateUser
function in the Auth0 wrapper you previously setup that makes a request to this endpoint.In order to support social login via OAuth you'll need to setup an Auth0 callback page and specify it's path as the Create an Auth0 callback page
redirectUri
value when callingauth0.popup.authorize()
. This page should use theauth0-js
library and callauth0.popup.callback()
on load. This is what enables your app to get the authentication results after the OAuth flow has completed.In order to make authenticated requests to Cloud Firestore you'll need to setup an API route that generates a custom Firebase token. Create an Express.js route at Get Auth0 working with Cloud Firestore
/api/firebase-token
that is passed the current Auth0 user'suid
and returns a custom Firebase token withfirebase.auth().createCustomToken(uid)
. Right after login you'll want to make a request to this API route and pass the retrieved token tosignInWithCustomToken(auth, token)
. This ensures that your Firestore rules will be able to read the user'suid
in order to dictate what queries the current user can make.Create Cloud Firestore query hooks
Create React hooks that wrap your Cloud Firestore queries, such asuseUser
,useItem
, anduseItemsByUser
. These hooks should subscribe to data usingonSnapshot
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.Add Firestore rules
Be sure to specify your Firestore security rules so that your Firestore database is secure. For example, if you have ausers
collection you might ensure that the authenticated user can only update a doc ifuserDoc.uid
matches theiruid
. If you have anitems
collection you might ensure that they can only update and fetch items whereitemDoc.owner
matches theiruid
. You'll also generally want to specify an array of fields that are writeable, as you wouldn't want a user to be able to changeuserDoc.planId
without actually upgrading their plan.Build a data-driven UI
Create a data-driven UI using your component library of choice that reads/writes data to Cloud Firestore. The specifics will depend on the type of app you're building, but we generally recommend having auseItemsByOwner
hook that fetches "items" in Cloud Firestore 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 modal and form components.Create an Express.js route at Integrate with Stripe Checkout
/api/stripe-checkout
that receives aplanId
value, creates a new Stripe Checkout session for the given plan usingstripe.checkout.sessions.create()
, and then returns thesession
object. Next you'll create a/purchase/[planId]
page that initiates the checkout flow. This page should automatically make a request to/api/stripe-checkout
to get a new Checkout session and and then redirect to Checkout by callingstripe.redirectToCheckout(session.id)
. Finally, you'll design your plan selection UI using your component library of choice and link each plan to the/purchase/[planId]
page you've setup above.Create an Express.js route at Integrate with Stripe Customer Portal
/api/stripe-portal
that creates a new Stripe Customer Portal session usingstripe.billingPortal.sessions.create()
and then returns thesession
object. Next you'll create a/settings/billing
page that initiates the Customer Portal flow. This page should automatically make a request to/api/stripe-portal
to get a new session and then redirect to the Customer Portal using thesession.url
value. Next you'll create a settings UI using your component library of choice and link to the/settings/billing
page you setup above. Now your users can easily manage billing info and change payment methods.In order to handle Stripe payment events you'll need to setup a webhook server endpoint. Create an Express.js route at Create a Stripe webhook
/api/stripe-webhook
that uses thestripe
library to parse data from the request body, validate the event usingstripe.webhooks.constructEvent()
, and then call a handler function for each of the following events:checkout.session.completed
,invoice.payment_succeeded
,invoice.payment_failed
,customer.subscription.updated
, andcustomer.subscription.deleted
. Your event handlers should update the user in the database so that your database contains their current plan and subscription status. When running your app locally, Stripe won't be able to ping your webhook endpoint, so you'll want to make sure to use the Stripe CLI to listen to events and route them to your local/api/stripe-webhook
endpoint.
Get the code
You can get the code for this guide with our React, Auth0, Cloud Firestore, and Stripe Boilerplate. You'll get a complete React codebase with Auth0, Cloud Firestore, and Stripe 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