Quick Start

Impatient?

If you're impatient, you can clone and run the Basic example right away with the following commands:

bash

npx degit https://github.com/tanstack/router/examples/react/start-basic start-basic
cd start-basic
npm install
npm run dev

npx degit https://github.com/tanstack/router/examples/react/start-basic start-basic
cd start-basic
npm install
npm run dev

If you'd like to use a different example, you can replace start-basic above with the slug of the example you'd like to use from the list below.

Once you've cloned the example you want, head back to the Learn the Basics guide to learn how to use TanStack Start!

Examples

TanStack Start has load of examples to get you started. Pick one of the examples below to get started!

Basic (start-basic)
Basic + Auth (start-basic-auth)
Basic + Counter (start-basic-counter)
Basic + React Query (start-basic-react-query)
Clerk Auth (start-clerk-basic)
Convex + Trellaux (start-convex-trellaux)
Supabase (start-supabase-basic)
Trellaux (start-trellaux)

Stackblitz

Each example above has an embedded stackblitz preview to find the one that feels like a good starting point

Quick Deploy

To quickly deploy an example, click the Deploy to Netlify button on an example's page to both clone and deploy the example to Netlify.

Manual Deploy

To manually clone and deploy the example to anywhere else you'd like, use the following commands replacing EXAMPLE_SLUG with the slug of the example you'd like to use from above:

bash

npx degit https://github.com/tanstack/router/examples/react/EXAMPLE_SLUG my-new-project
cd my-new-project
npm install
npm run dev

npx degit https://github.com/tanstack/router/examples/react/EXAMPLE_SLUG my-new-project
cd my-new-project
npm install
npm run dev

Once you've clone or deployed an example, head back to the Learn the Basics guide to learn how to use TanStack Start!

Other Router Examples

While not Start-specific examples, these may help you understand more about how TanStack Router works: