Skip to content

Latest commit

 

History

History
75 lines (54 loc) · 2.27 KB

README.md

File metadata and controls

75 lines (54 loc) · 2.27 KB

TanStack Router Template

My basic template with TanStack Router and a few other libraries.

image

Features

  • ⚡️ Vite - Lightning fast build tool
  • 🎯 TanStack Router - Type-safe routing for React
  • ⚛️ React 18 - The library for web and native user interfaces
  • 🔍 TypeScript - JavaScript with syntax for types
  • 🎨 Tailwind CSS - A utility-first CSS framework
  • 📡 TanStack Query - Powerful asynchronous state management
  • 🏪 Zustand - Bear necessities for state management
  • 📝 React Hook Form - Performant form validation
  • 🔐 Zod - TypeScript-first schema validation
  • 🎭 Radix UI - Unstyled, accessible components
  • 🎯 ESLint - Code linting with modern config
  • 🎯 TypeScript ESLint - TypeScript support in ESLint

Getting Started

Prerequisites

  • Node.js (v18 or higher)
  • pnpm

Installation

Clone the repository:

git clone https://github.com/toyamarodrigo/tanstack-router-template.git
cd tanstack-router-template

Install dependencies:

pnpm install

Start the development server:

pnpm dev

The application will be available at http://localhost:3000.

Available Scripts

  • pnpm dev - Start development server at port 3000
  • pnpm build - Build for production
  • pnpm serve - Preview production build at port 5000
  • pnpm lint - Run ESLint
  • pnpm lint:fix - Fix ESLint errors
  • pnpm typecheck - Check TypeScript types

Project Structure

src/
├── routes/           # Route components and definitions
├── components/       # Reusable UI components
├── styles/          # Global styles and Tailwind config
├── lib/             # Utility functions and configurations
├── app.tsx          # Main application component
└── main.tsx         # Application entry point

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.