0
Fork 0
mirror of https://github.com/TanStack/router.git synced 2026-11-16 19:38:07 +00:00
router/examples/react/basic-file-based/README.md
Ender Bonnet 6d619da632
docs(examples): standardize the READMEs for the React examples (#6014)
Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>
2025-12-07 01:39:44 +13:00

720 B

TanStack Router - File-Based Routing Example

An example demonstrating file-based routing with TanStack Router.

Start a new project based on this example

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

npx gitpick TanStack/router/tree/main/examples/react/basic-file-based basic-file-based

Getting Started

Install dependencies:

pnpm install

Start the development server:

pnpm dev

Build

Build for production:

pnpm build

About This Example

This example demonstrates:

  • File-based route generation
  • Automatic route tree creation
  • Route file conventions
  • Type-safe routing with file-based routes