Quick Start

::: tip TL;DR

git clone -o seed -b main --single-branch \
  https://github.com/kriasoft/react-starter-kit.git my-app
cd my-app && bun install && bun dev

:::

Prerequisites

• Bun 1.3.0 or later
• A Cloudflare account (free tier works)

::: info Node.js Optional This project runs entirely on Bun. You don't need Node.js unless you're integrating with Node-specific tools. :::

Create Your Project

Option A: GitHub Template

1. Go to github.com/kriasoft/react-starter-kit
2. Click "Use this template" → "Create a new repository"
3. Clone your new repository:

git clone https://github.com/YOUR_USERNAME/YOUR_PROJECT.git
cd YOUR_PROJECT
bun install

::: tip This creates a clean repository without the template's commit history. :::

Option B: Git Clone

Clone with a custom remote name so you can pull template updates later:

git clone -o seed -b main --single-branch \
  https://github.com/kriasoft/react-starter-kit.git my-app
cd my-app
bun install

Add your own repository as origin:

git remote add origin https://github.com/YOUR_USERNAME/YOUR_PROJECT.git
git push -u origin main

To pull template updates later:

git fetch seed
git merge seed/main

::: warning Review template updates carefully before merging – schema or config changes may need manual resolution. :::

Start the Dev Server

bun dev

This starts three services concurrently:

You can also start services individually:

bun app:dev     # React app only
bun api:dev     # API server only
bun web:dev     # Marketing site only
bun email:dev   # Email template preview at http://localhost:3001

Explore the Stack

• App at http://localhost:5173 – your React app with TanStack Router
• API at http://localhost:8787 – tRPC endpoints
• Database GUI – run bun db:studio to open Drizzle Studio
• Email preview – run bun email:dev for template preview at http://localhost:3001

Make It Yours

1. Update branding in apps/app/index.html
2. Edit the homepage at apps/app/routes/(app)/index.tsx
3. Add API procedures in apps/api/routers/
4. Define data models in db/schema/

Development Commands

bun dev          # Start all services concurrently
bun test         # Run tests (Vitest, single run)
bun lint         # ESLint with cache
bun typecheck    # TypeScript type checking (tsc --build)
bun build        # Production build: email → web → api → app

::: info After modifying tRPC routes, types update automatically – no manual sync needed. After editing db/schema/, run bun db:generate then bun db:push to apply changes. :::