Skip to content
Source
Sign inSign up
TanStack/router
Open History to see the last commit

getting-started.md

65 lines2.1 KB

1---
2id: getting-started
3title: Getting Started
4redirect_from:
5 - /framework/solid/quick-start
6---
7​
8## Start a new project
9​
10### Use TanStack Builder
11​
12The 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.
13​
14### Use the CLI
15​
16If you'd rather scaffold locally or want a backup path, use the TanStack CLI:
17​
18```bash
19npx @tanstack/cli@latest create --framework solid
20```
21​
22You'll be prompted to choose your package manager and optional add-ons like Tailwind CSS and ESLint.
23​
24### Start from an example
25​
26If you'd rather begin from a working codebase, clone one of the official examples.
27​
28To start with the [Basic](https://github.com/TanStack/router/tree/main/examples/solid/start-basic) example:
29​
30```bash
31npx gitpick TanStack/router/tree/main/examples/solid/start-basic start-basic
32cd start-basic
33npm install
34npm run dev
35```
36​
37To use a different example, replace `start-basic` with one of the slugs below.
38​
39#### Examples
40​
41- [Bare](https://github.com/TanStack/router/tree/main/examples/solid/start-bare) (`start-bare`)
42- [Basic](https://github.com/TanStack/router/tree/main/examples/solid/start-basic) (`start-basic`)
43- [Basic Static](https://github.com/TanStack/router/tree/main/examples/solid/start-basic-static) (`start-basic-static`)
44- [Counter](https://github.com/TanStack/router/tree/main/examples/solid/start-counter) (`start-counter`)
45​
46Each example page also includes a StackBlitz preview so you can inspect it before cloning.
47​
48To clone a different example manually, replace `EXAMPLE_SLUG` below with the slug you want to use:
49​
50```bash
51npx gitpick TanStack/router/tree/main/examples/solid/EXAMPLE_SLUG my-new-project
52cd my-new-project
53npm install
54npm run dev
55```
56​
57If you want to clone and deploy quickly, use the **Deploy to Netlify** button on an example's page.
58​
59### Build from scratch
60​
61If you want to wire everything up by hand, follow [Build a project from scratch](./build-from-scratch).
62​
63## Next Steps
64​
65Once you've created, cloned, or deployed a project, continue to the [Routing](./guide/routing) guide.