Frontend Starter

A small React and TypeScript template for new frontend projects.

Requirements

• Node.js 22.12 or newer
• Bun 1.4.4, as set in package.json

Getting started

After cloning the project, run these commands in the project folder:

bun install --frozen-lockfile
bun run dev

Open the local URL shown in the terminal.

--frozen-lockfile installs the versions saved in bun.lock. It stops if package.json and the lockfile do not match. Keep both files in version control.

Commands

Command	What it does
bun run dev	Start the development server
bun run check	Check formatting, lint, types, and the build
bun run build	Check types and create a build in dist/
bun run preview	Preview the existing build locally
bun run lint	Check code with Oxlint
bun run fmt	Format files with Oxfmt
bun run fmt:check	Check formatting without changing files

Run bun run check before committing changes. Run bun run build before using bun run preview.

Included

• React, TypeScript, Vite, and React Compiler
• TanStack Router with file routes and automatic code splitting
• TanStack Query with a shared client
• Tailwind CSS and shadcn/ui setup with Base UI
• Light, dark, and system theme support
• i18next setup for English and Turkish
• Query and Router Devtools in development

TanStack Form and Zod are installed for forms and validation. Add shadcn/ui components as needed.

Project structure

src/
  components/    # UI components and providers
  i18n/          # Language setup and translation files
  lib/           # Shared application setup
  routes/        # Route definitions and pages
  main.tsx       # App entry point and devtools

src/routeTree.gen.ts is generated by TanStack Router. Do not edit it by hand.

AI coding tools should follow the project instructions in AGENTS.md.