https://github.com/clerk/clerk-react-quickstart
https://github.com/clerk/clerk-react-quickstart
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/clerk/clerk-react-quickstart
- Owner: clerk
- Created: 2023-11-25T01:31:21.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-29T19:55:32.000Z (about 1 year ago)
- Last Synced: 2025-04-29T20:37:04.526Z (about 1 year ago)
- Language: CSS
- Size: 372 KB
- Stars: 26
- Watchers: 3
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Clerk and React Quickstart
## 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](https://clerk.com/docs/quickstarts/react), 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 ``
- Use Clerk components to protect your content
- Embed the `` and ``
- Deploy your application
### Branches of this repository
- `main`: The result of following the [Clerk React quickstart](https://clerk.com/docs/quickstarts/react).
- `integrate-react-router-dom-using-data-router`: The result of following the [Add React Router](https://clerk.com/docs/references/react/add-react-router#add-react-router-to-your-clerk-powered-react-application) guide.
## Deploy
Easily deploy the template to Vercel with the button below. You will need to set the required environment variables in the Vercel dashboard.
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fclerk%2Fclerk-react-quickstart&env=VITE_CLERK_PUBLISHABLE_KEY,CLERK_SECRET_KEY&envDescription=Clerk%20API%20keys&envLink=https%3A%2F%2Fclerk.com%2Fdocs%2Fquickstart%2Freact&redirect-url=https%3A%2F%2Fclerk.com%2Fdocs%2Fquickstart%2Freact)
## Running the template
```bash
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](https://dashboard.clerk.com/sign-up?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=10-24-2023&utm_term=clerk-react-quickstart).
2. Go to the [Clerk dashboard](https://dashboard.clerk.com?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=10-24-2023&utm_term=clerk-react-quickstart) and create an application.
3. Set the required Clerk environment variables as shown in [the example `env` file](./.env.sample).
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:
- [Quickstart: Get started with React and Clerk](https://clerk.com/docs/quickstarts/react?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=10-24-2023&utm_term=clerk-react-quickstart)
- [Clerk Documentation](https://clerk.com/docs?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=10-24-2023&utm_term=clerk-react-quickstart)
- [Vite Documentation](https://vitejs.dev/guide/)
## Found an issue or want to leave feedback
Feel free to create a support thread on our [Discord](https://clerk.com/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](https://discord.com/invite/b5rXHjAg7A).
If you prefer, you can also find support through our [Twitter](https://twitter.com/ClerkDev), or you can [email](mailto:support@clerk.dev) us!