https://github.com/clerk/clerk-remix-quickstart
Learn how to use Clerk to quickly add secure authentication and user management to your Remix application. This repo assumed you are using Remix v2 or later
https://github.com/clerk/clerk-remix-quickstart
authentication clerk quickstart react remix tempalte
Last synced: 11 months ago
JSON representation
Learn how to use Clerk to quickly add secure authentication and user management to your Remix application. This repo assumed you are using Remix v2 or later
- Host: GitHub
- URL: https://github.com/clerk/clerk-remix-quickstart
- Owner: clerk
- License: mit
- Created: 2024-01-16T08:52:35.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T16:54:27.000Z (over 1 year ago)
- Last Synced: 2024-09-17T20:52:09.017Z (over 1 year ago)
- Topics: authentication, clerk, quickstart, react, remix, tempalte
- Language: TypeScript
- Homepage:
- Size: 903 KB
- Stars: 7
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Clerk and Remix Quickstart
## Introduction
Clerk is a developer-first authentication and user management solution. It provides pre-built 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 integrated into any Remix application.
After following the [Clerk Remix quickstart](https://clerk.com/docs/quickstarts/remix?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=clerk-remix-quickstart), you will have learned how to:
- Install `@clerk/remix`
- Set your Clerk API keys
- Configure `rootAuthLoader`
- Configure `ClerkApp`
- Protect your pages
## 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-remix-quickstart&env=REMIX_CLERK_PUBLISHABLE_KEY,CLERK_SECRET_KEY&envDescription=Clerk%20API%20keys&envLink=https%3A%2F%2Fclerk.com%2Fdocs%2Fquickstart%2Fremix&redirect-url=https%3A%2F%2Fclerk.com%2Fdocs%2Fquickstart%2Fremix)
## Running the template
```bash
git clone https://github.com/clerk/clerk-remix-quickstart
```
To run the example locally, you need to:
1. Sign up for a Clerk account at [https://clerk.com](https://www.clerk.com?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=clerk-remix-quickstart).
2. Go to the [Clerk dashboard](https://dashboard.clerk.com) 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.
## Where the magic happens
In Remix, `app/root.tsx` wraps your entire application in both server and browser contexts. Clerk makes two modifications to this file so the authentication state is shared with your Remix routes.
1. `rootAuthLoader` exported as `loader`.
2. The default export wrapped with `ClerkApp`.
For more details, please refer to the [Remix quickstart](https://clerk.com/docs/quickstarts/remix?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=clerk-remix-quickstart) guide, or take a look at the [`app/root.tsx`](./app/root.tsx) file.
## Learn more
To learn more about Clerk and Remix, check out the following resources:
- [Quickstart: Get started with Remix and Clerk](https://clerk.com/docs/quickstarts/remix?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=clerk-remix-quickstart)
- [Clerk Documentation](https://clerk.com/docs?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=clerk-remix-quickstart)
- [Remix Documentation](https://remix.run/docs?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=clerk-remix-quickstart)
## 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!