Overview:
The Remix Auth Starter is a starter application that demonstrates how to add authentication to your Remix application using Clerk. It provides examples of features such as sign up, sign in, profile management, and an authenticated API route. The starter works with Remix SSR and supports server-side rendering out-of-the-box.
Features:
- Sign up: Allows users to create a new account.
- Sign in: Allows users to authenticate and sign into their account.
- Profile management: Provides functionality to manage user profiles.
- Authenticated API route: Includes an example of an authenticated API route.
Installation:
To run the Remix Auth Starter locally, follow these steps:
- Sign up for a Clerk account at https://clerk.dev.
- Clone this repository locally.
- Rename the
.env.samplefile to.envand set the requiredCLERK_PUBLISHABLE_KEYandCLERK_SECRET_KEYvariables from the API keys screen in your Clerk dashboard. - Run
npm installto install the required dependencies. - Run
npm run devto start the development server. - Open http://localhost:3000 in your browser and you’re ready to go!
Summary:
The Remix Auth Starter is a useful example for adding authentication to your Remix application using Clerk. It provides a range of features including sign up, sign in, profile management, and an authenticated API route. The starter is easy to install and works well with Remix SSR. It also follows Remix conventions for loaders and higher-order components. Overall, this starter is a great resource for developers looking to incorporate authentication into their Remix applications.