Skip to content

Latest commit

 

History

History
76 lines (56 loc) · 3.58 KB

README.md

File metadata and controls

76 lines (56 loc) · 3.58 KB
Raw

Clerk Logo for light background

Clerk and TanStack Start Quickstart

Downloads Discord Twitter

Clerk Hero Image

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 TanStack Start application.

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

  • Create a new TanStack Start application
  • Install @clerk/tanstack-start@beta
  • Set up your environment keys
  • Wrap your Root Component with <ClerkProvider />
  • Configure clerkHandler() in the SSR entrypoint
  • Use Clerk components to protect your content
  • Embed the <SignInButton /> and <SignOutButton />
  • Deploy your application

Running the template

git clone https://github.com/clerk/clerk-tanstack-start-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 TanStack Start, 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!