Clerk is the easiest way to add authentication and user management to your Remix application. Add sign up, sign in, and profile management to your application in minutes.
- Remix
^2.0.0or later - React 18 or later
- Node.js
>=18.17.0or later
npm install @clerk/remixTo build the package locally with the TypeScript compiler, run:
npm run buildTo build the package in watch mode, run the following:
npm run devMake sure the following environment variables are set in a .env file:
CLERK_PUBLISHABLE_KEY=[publishable-key]
CLERK_SECRET_KEY=[backend-secret-key]You can get these from the API Keys screen in your Clerk dashboard.
To initialize Clerk with your Remix application, you will need to make three modifications to app/root.jsx:
- Export
rootAuthLoaderasloader - Wrap the default export with
ClerkApp
import { rootAuthLoader } from '@clerk/remix/ssr.server';
import { ClerkApp } from '@clerk/remix';
export const loader = args => rootAuthLoader(args);
function App() {
return <html lang='en'>[...]</html>;
}
export default ClerkApp(App);After those changes are made, you can use Clerk components in your routes.
For example, in app/routes/index.jsx:
import { SignedIn, SignedOut, SignInButton, UserButton } from '@clerk/remix';
export default function Index() {
return (
<div
style={{
fontFamily: 'system-ui, sans-serif',
lineHeight: '1.4',
textAlign: 'center',
}}
>
<h1>Hello Clerk!</h1>
<SignedIn>
<UserButton />
</SignedIn>
<SignedOut>
<SignInButton mode='modal' />
</SignedOut>
</div>
);
}For further details and examples, please refer to our Documentation.
You can get in touch with us in any of the following ways:
- Join our official community Discord server
- Create a GitHub Discussion
- Contact options listed on our Support page
We're open to all community contributions! If you'd like to contribute in any way, please read our contribution guidelines.
@clerk/remix follows good practices of security, but 100% security cannot be assured.
@clerk/remix is provided "as is" without any warranty. Use at your own risk.
For more information and to report security issues, please refer to our security documentation.
This project is licensed under the MIT license.
See LICENSE for more information.