Skip to content

Learn how to use Clerk to quickly add secure authentication and user management to your Remix application. This repo assumed you are using Remix v2 or later

License

Notifications You must be signed in to change notification settings

clerk/clerk-remix-quickstart

Repository files navigation

Clerk Logo for light background

Clerk and Remix Quickstart

Downloads Discord Twitter

Clerk Hero Image

Introduction

Clerk is a developer-first authentication and user management solution. It provides pre-built components and hooks for sign-in, sign-up, user profile, and organization management. Clerk is designed to be easy to use and customize, and can be integrated into any Remix application.

After following the Clerk Remix quickstart, you will have learned how to:

  • Install @clerk/remix
  • Set your Clerk API keys
  • Configure rootAuthLoader
  • Configure ClerkApp
  • Protect your pages

Deploy

Easily deploy the template to Vercel with the button below. You will need to set the required environment variables in the Vercel dashboard.

Deploy with Vercel

Running the template

git clone https://github.com/clerk/clerk-remix-quickstart

To run the example locally, you need to:

  1. Sign up for a Clerk account at https://clerk.com.

  2. Go to the Clerk dashboard and create an application.

  3. Set the required Clerk environment variables as shown in the example env file.

  4. npm install the required dependencies.

  5. npm run dev to launch the development server.

Where the magic happens

In Remix, app/root.tsx wraps your entire application in both server and browser contexts. Clerk makes two modifications to this file so the authentication state is shared with your Remix routes.

  1. rootAuthLoader exported as loader.
  2. The default export wrapped with ClerkApp.

For more details, please refer to the Remix quickstart guide, or take a look at the app/root.tsx file.

Learn more

To learn more about Clerk and Remix, check out the following resources:

Found an issue or want to leave feedback

Feel free to create a support thread on our Discord. Our support team will be happy to assist you in the #support channel.

Connect with us

You can discuss ideas, ask questions, and meet others from the community in our Discord.

If you prefer, you can also find support through our Twitter, or you can email us!

About

Learn how to use Clerk to quickly add secure authentication and user management to your Remix application. This repo assumed you are using Remix v2 or later

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published