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:
- Create a new Remix application
- Install
@clerk/remix - Set up your environment keys
- Import the Clerk Publishable Key
- Wrap your Remix app in
<ClerkProvider /> - Use Clerk components to protect your content
- Embed the
<SignInButton />and<SignOutButton /> - Deploy your application
Easily deploy the template to Vercel with the button below. You will need to set the required environment variables in the Vercel dashboard.
git clone https://github.com/clerk/clerk-remix-quickstartTo run the example locally, you need to:
-
Sign up for a Clerk account at https://clerk.com.
-
Go to the Clerk dashboard and create an application.
-
Set the required Clerk environment variables as shown in the example
envfile. -
npm installthe required dependencies. -
npm run devto launch the development server.
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.
rootAuthLoaderexported asloader.- The default export wrapped with
ClerkApp.
For more details, please refer to the Use Clerk with Remix guide, or take a look at the app/root.tsx file.
To learn more about Clerk and Remix, check out the following resources:
Feel free to create a support thread on our Discord. Our support team will be happy to assist you in the #support channel.
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!