ContextQMD
Back to Clerk

README

packages/tanstack-react-start/README.md

latest3.6 KB
Original Source
<p align="center"> <a href="https://clerk.com?utm_source=github&utm_medium=clerk_tanstack_react_start" target="_blank" rel="noopener noreferrer"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://images.clerk.com/static/logo-dark-mode-400x400.png"> 
</picture>
</a> <h1 align="center">@clerk/tanstack-react-start</h1> </p> <div align="center">

Changelog · Report a Bug · Request a Feature · Get help

</div>

Getting Started

Clerk is the easiest way to add authentication and user management to your Tanstack Start application. Add sign up, sign in, and profile management to your application in minutes.

Prerequisites

  • TanStack Start ^1.157.0 or later
  • TanStack Router ^1.157.0 or later
  • React 18 or later
  • Node.js >=20.9.0 or later
  • An existing Clerk application. Create your account for free.

Installation

The fastest way to get started with Clerk is by following the TanStack React Start Quickstart.

You'll learn how to install @clerk/tanstack-react-start, set up your environment keys, configure createClerkHandler and protect your pages.

Usage

For further information, guides, and examples visit the TanStack React Start reference documentation.

Support

You can get in touch with us in any of the following ways:

Contributing

We're open to all community contributions! If you'd like to contribute in any way, please read our contribution guidelines and code of conduct.

Security

@clerk/tanstack-react-start follows good practices of security, but 100% security cannot be assured.

@clerk/tanstack-react-start is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.

License

This project is licensed under the MIT license.

See LICENSE for more information.