Back to Router

TanStack Router - Kitchen Sink File-Based Example

examples/react/kitchen-sink-file-based/README.md

1.166.7857 B
Original Source

TanStack Router - Kitchen Sink File-Based Example

A comprehensive file-based routing example demonstrating many TanStack Router features.

Start a new project based on this example

To start a new project based on this example, run:

sh
npx gitpick TanStack/router/tree/main/examples/react/kitchen-sink-file-based kitchen-sink-file-based

Getting Started

Install dependencies:

sh
pnpm install

Start the development server:

sh
pnpm dev

Build

Build for production:

sh
pnpm build

About This Example

This "kitchen sink" example with file-based routing demonstrates:

  • File-based route generation
  • Advanced routing patterns
  • Nested routes
  • Route parameters and search params
  • Data loading
  • Error handling
  • Route guards
  • Type-safe file-based routes