Skip to content

Latest commit

 

History

History
145 lines (100 loc) · 4.44 KB

README.md

File metadata and controls

145 lines (100 loc) · 4.44 KB
Raw


@clerk/remix

Overview

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.

Getting Started

Prerequisites

  • Remix v1.2+
  • Node.js v16+

Installation

npm install @clerk/remix

Build

To build the package locally with the TypeScript compiler, run:

npm run build

To build the package in watch mode, run the following:

npm run dev

Usage

Make sure the following environment variables are set in a .env file:

CLERK_FRONTEND_API=[frontend-api-key]
CLERK_API_KEY=[backend-api-key]
CLERK_JWT_KEY=[jwt-verification-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:

  1. Export rootAuthLoader as loader
  2. Export ClerkCatchBoundary as CatchBoundary
  3. Wrap the default export with ClerkApp
import { rootAuthLoader } from '@clerk/remix/ssr.server';
import { ClerkApp, ClerkCatchBoundary } from '@clerk/remix';

export const loader = args => rootAuthLoader(args);
export const CatchBoundary = ClerkCatchBoundary();

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.

Support

You can get in touch with us in any of the following ways:

Contributing

We're open to all community contributions! If you'd like to contribute in any way, please read our contribution guidelines.

Security

@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.

License

This project is licensed under the MIT license.

See LICENSE for more information.