Skip to content

zek01svg/tanstack-start-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TanStack Start Template

A premium, batteries-included template for building modern web applications with TanStack Start, Nitro, Better Auth, and Drizzle ORM. Featuring a refined Stark hyper-minimalist design system.

🚀 Features

  • SSR & Routing: TanStack Start for seamless SSR and type-safe routing.
  • Server Engine: Nitro for high-performance server-side logic.
  • Authentication: Better Auth for email OTP sign-in/sign-up, Google OAuth, and passkey support.
  • Database: Drizzle ORM with PostgreSQL (pg).
  • Styling: Tailwind CSS v4 for ultra-fast utility-first styling.
  • Theme System: Class-based light/dark switching with next-themes, with system preference handled by the provider.
  • Architecture: Modular feature-based structure (src/features) for scalable development.
  • Design: Hyper-minimalist aesthetic with centered typography and subtle Oklch gradients.
  • Observability: LogTape-backed structured logging with a Sentry sink for error tracking and performance monitoring.
  • Developer Experience:
    • Oxlint & Oxfmt for lightning-fast linting and formatting.
    • Turbo for efficient task orchestration.
    • Playwright for E2E testing in tests/e2e.
    • Vitest for unit and component tests in tests/unit.
    • Lefthook for flexible, fast git hooks.

🛠️ Getting Started

Prerequisites

  • Bun (v1.3.13 or later)
  • Docker (for local database)

Setup

  1. Install dependencies:

    bun install
  2. Environment Variables: Copy .env.example to .env:

    cp .env.example .env

    Update the variables with your configuration.

  3. Database: Start the database using Docker Compose:

    docker compose up -d

    Push the schema to the database:

    bun run db:push
  4. Run Development Server:

    bun run dev

    Open http://localhost:3000 in your browser.

🧪 Testing

  • Unit: bun run test:unit
  • E2E: bun run test:e2e
  • Interactive E2E: bunx playwright test --ui

🐳 Deployment

The project is ready for Dockerized deployment.

docker build -t tanstack-start-template .
docker run -p 3000:3000 tanstack-start-template

🏛️ Documentation

  • Architecture: Deep dive into the project structure and data flow.
  • Design System: Details on the aesthetic and design tokens.
  • Agents Guide: Practical instructions for working in this codebase.
  • Changelog: Recorded changes and version history.

About

A batteries-included, production-ready TanStack Start template with a focus on performance and DX.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages