ContextQMD
Back to Supabase

Social Authentication

apps/ui-library/content/docs/react-router/social-auth.mdx

1.26.042.9 KB
Original Source
<BlockPreview name="social-auth/auth/login" /> <Callout className="mt-4"> The block is using GitHub provider by default, but can be easily switched by changing a single parameter. </Callout>

Installation

<BlockItem name="social-auth-react-router" description="All needed components for the social auth flow" />

Folder structure

This block includes the Supabase client. If you already have one installed, you can skip overwriting it.

<RegistryBlock itemName="social-auth-react-router" />

Usage

Once you install the block in your React Router project, you'll get all the necessary pages and components to set up a social authentication flow.

Getting started

After installing the block, you'll have the following environment variables in your .env.local file:

env
VITE_SUPABASE_URL=
VITE_SUPABASE_PUBLISHABLE_KEY=

  • If you're using supabase.com, you can find these values in the Connect modal under App Frameworks or in your project's API settings.

  • If you're using a local instance of Supabase, you can find these values by running supabase start or supabase status (if you already have it running).

Setting up third party providers

We support a wide variety of social providers that you can use to integrate with your application. The full list is available here. This block uses the PKCE flow with GitHub as the provider. To switch providers, just update the provider field in the supabase.auth.signInWithOAuth call. Enable the provider you want to use under Auth Providers in the Supabase Dashboard and add the necessary credentials.

Setting up routes and redirect URLs

  1. Set the site URL in the URL Configuration settings in the Supabase Dashboard.
  2. Update the redirect paths in login-form.tsx to point to your app’s logged-in routes. Our examples use /protected, but you can set this to whatever fits your app.
  3. Visit http://your-site-url/login to see this component in action.

Combining social auth with password-based auth

If you want to combine this block with the password-based auth, you need to:

  • Copy the @/app/routes/auth.oauth.tsx in your app under the same route.
  • Copy just the action from the social login page into a separate route.
  • In the password-based login.tsx page, create another form with a "Login with ..." button. The method should be post and the action should point at the action route from the previous step.

Further reading