https://github.com/clerk/clerk-react-router-quickstart
The official companion repo for Clerk's React Router Quickstart
https://github.com/clerk/clerk-react-router-quickstart
Last synced: about 1 year ago
JSON representation
The official companion repo for Clerk's React Router Quickstart
- Host: GitHub
- URL: https://github.com/clerk/clerk-react-router-quickstart
- Owner: clerk
- Created: 2024-12-03T09:09:51.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-24T10:10:09.000Z (over 1 year ago)
- Last Synced: 2025-03-10T03:55:25.241Z (over 1 year ago)
- Language: TypeScript
- Size: 61.5 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Clerk and React Router 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 Router quickstart](https://clerk.com/docs/quickstarts/react-router), you will have learned how to:
- Install `@clerk/react-router`
- Set your Clerk API keys
- Configure rootAuthLoader
- Add `` and Clerk components
## 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-router-quickstart&env=CLERK_PUBLISHABLE_KEY,CLERK_SECRET_KEY&envDescription=Clerk%20API%20keys&envLink=https%3A%2F%2Fclerk.com%2Fdocs%2Fquickstart%2Freact-router&redirect-url=https%3A%2F%2Fclerk.com%2Fdocs%2Fquickstart%2Freact-router)
## Running the template
```bash
git clone https://github.com/clerk/clerk-react-router-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=react-router-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=react-router-quickstart) and create an application.
3. Set the required Clerk environment variables as shown in [the example `env` file](./.env.example).
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 Router and Clerk](https://clerk.com/docs/quickstarts/react-router?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=10-24-2023&utm_term=react-router-quickstart)
- [Clerk Documentation](https://clerk.com/docs?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=10-24-2023&utm_term=react-router-quickstart)
- [React Router Documentation](https://reactrouter.com/home)
## 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!