Skip to content

clerk/clerk-react-quickstart

Repository files navigation

Clerk Logo for light background

Clerk and React Quickstart

Downloads Discord Twitter

Clerk Hero Image

Introduction

Clerk is a developer-first authentication and user management solution. It provides pre-built React 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 dropped into any React application.

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

  • Create a new React application using Vite
  • Install @clerk/clerk-react
  • Set up your environment keys
  • Import the Clerk Publishable Key
  • Wrap your React app in <ClerkProvider />
  • Use Clerk components to protect your content
  • Embed the <SignInButton /> and <SignOutButton />
  • Deploy your application

Branches of this repository

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

Learn more

To learn more about Clerk and React, 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!