Skip to main content

Getting Started

还没翻译译自英文（tanstack.com）本页 25 段都还没译

Start a new project

Use TanStack Builder

The best way to get started with TanStack Start is TanStack Builder. It's the AI-first setup flow and the easiest way to get to a working project fast.

Use the CLI

If you'd rather scaffold locally or want a backup path, use the TanStack CLI:

npx @tanstack/cli@latest create

You'll be prompted to choose your package manager and optional add-ons like Tailwind CSS and ESLint.

Start from an example

If you'd rather begin from a working codebase, clone one of the official examples.

To start with the Basic example:

npx gitpick TanStack/router/tree/main/examples/react/start-basic start-basic
cd start-basic
npm install
npm run dev

To use a different example, replace start-basic with one of the slugs below.

Examples

Each example page also includes a StackBlitz preview so you can inspect it before cloning.

To clone a different example manually, replace EXAMPLE_SLUG below with the slug you want to use:

npx gitpick TanStack/router/tree/main/examples/react/EXAMPLE_SLUG my-new-project
cd my-new-project
npm install
npm run dev

If you want to clone and deploy quickly, use the Deploy to Netlify button on an example's page.

Build from scratch

If you want to wire everything up by hand, follow Build a project from scratch.

Migrate an existing project from another framework

  • If you want to learn Start from a clean slate first, use one of the new-project options above.
  • Refer to a migration guide for your specific framework:
    • Next.js
    • Remix 2 / React Router 7 "Framework Mode" (coming soon!)

Next Steps

Once you've created, cloned, or deployed a project, continue to the Routing guide.

Other Router Examples

If you want Router-focused examples that are not Start-specific, these are useful references:

Edit on GitHub
AI 翻译查看英文原文