Open History to see the last commit
1---
2id: getting-started
3title: Getting Started
4redirect_from:
5 - /framework/react/quick-start
6description: Create a TanStack Start application with TanStack Builder, the CLI, or a working example, then run it locally and start adding routes.
7---
8β
9## Start a new project
10β
11### Use TanStack Builder
12β
13The best way to get started with TanStack Start is [TanStack Builder](https://tanstack.com/builder). It's the AI-first setup flow and the easiest way to get to a working project fast.
14β
15### Use the CLI
16β
17If you'd rather scaffold locally or want a backup path, use the TanStack CLI:
18β
19```bash
20npx @tanstack/cli@latest create
21```
22β
23You'll be prompted to choose your package manager and optional add-ons like Tailwind CSS and ESLint.
24β
25### Start from an example
26β
27If you'd rather begin from a working codebase, clone one of the official examples.
28β
29To start with the [Basic](https://github.com/TanStack/router/tree/main/examples/react/start-basic) example:
30β
31```bash
32npx gitpick TanStack/router/tree/main/examples/react/start-basic start-basic
33cd start-basic
34npm install
35npm run dev
36```
37β
38To use a different example, replace `start-basic` with one of the slugs below.
39β
40#### Examples
41β
42- [Basic](https://github.com/TanStack/router/tree/main/examples/react/start-basic) (`start-basic`)
43- [Basic + Rsbuild](https://github.com/TanStack/router/tree/main/examples/react/start-basic-rsbuild) (`start-basic-rsbuild`)
44- [Basic + Auth](https://github.com/TanStack/router/tree/main/examples/react/start-basic-auth) (`start-basic-auth`)
45- [Counter](https://github.com/TanStack/router/tree/main/examples/react/start-counter) (`start-counter`)
46- [Basic + React Query](https://github.com/TanStack/router/tree/main/examples/react/start-basic-react-query) (`start-basic-react-query`)
47- [Clerk Auth](https://github.com/TanStack/router/tree/main/examples/react/start-clerk-basic) (`start-clerk-basic`)
48- [Convex + Trellaux](https://github.com/TanStack/router/tree/main/examples/react/start-convex-trellaux) (`start-convex-trellaux`)
49- [Supabase](https://github.com/TanStack/router/tree/main/examples/react/start-supabase-basic) (`start-supabase-basic`)
50- [Trellaux](https://github.com/TanStack/router/tree/main/examples/react/start-trellaux) (`start-trellaux`)
51- [WorkOS](https://github.com/TanStack/router/tree/main/examples/react/start-workos) (`start-workos`)
52- [Material UI](https://github.com/TanStack/router/tree/main/examples/react/start-material-ui) (`start-material-ui`)
53β
54Each example page also includes a StackBlitz preview so you can inspect it before cloning.
55β
56To clone a different example manually, replace `EXAMPLE_SLUG` below with the slug you want to use:
57β
58```bash
59npx gitpick TanStack/router/tree/main/examples/react/EXAMPLE_SLUG my-new-project
60cd my-new-project
61npm install
62npm run dev
63```
64β
65If you want to clone and deploy quickly, use the **Deploy to Netlify** button on an example's page.
66β
67### Build from scratch
68β
69If you want to wire everything up by hand, follow [Build a project from scratch](./build-from-scratch).
70β
71## Migrate an existing project from another framework
72β
73- If you want to learn Start from a clean slate first, use one of the new-project options above.
74- Refer to a migration guide for your specific framework:
75 - [Next.js](./migrate-from-next-js)
76 - Remix 2 / React Router 7 "Framework Mode" (coming soon!)
77β
78## Next Steps
79β
80Once you've created, cloned, or deployed a project, continue to the [Routing](./guide/routing) guide.
81β
82## Other Router Examples
83β
84If you want Router-focused examples that are not Start-specific, these are useful references:
85β
86- [Quickstart (file-based)](https://github.com/TanStack/router/tree/main/examples/react/quickstart-file-based)
87- [Basic (file-based)](https://github.com/TanStack/router/tree/main/examples/react/basic-file-based)
88- [Kitchen Sink (file-based)](https://github.com/TanStack/router/tree/main/examples/react/kitchen-sink-file-based)
89- [Kitchen Sink + React Query (file-based)](https://github.com/TanStack/router/tree/main/examples/react/kitchen-sink-react-query-file-based)
90- [Location Masking](https://github.com/TanStack/router/tree/main/examples/react/location-masking)
91- [Authenticated Routes](https://github.com/TanStack/router/tree/main/examples/react/authenticated-routes)
92- [Scroll Restoration](https://github.com/TanStack/router/tree/main/examples/react/scroll-restoration)
93- [Deferred Data](https://github.com/TanStack/router/tree/main/examples/react/deferred-data)
94- [Navigation Blocking](https://github.com/TanStack/router/tree/main/examples/react/navigation-blocking)
95- [View Transitions](https://github.com/TanStack/router/tree/main/examples/react/view-transitions)
96- [With tRPC](https://github.com/TanStack/router/tree/main/examples/react/with-trpc)
97- [With tRPC + React Query](https://github.com/TanStack/router/tree/main/examples/react/with-trpc-react-query)