# Clone the template
npx degit bskimball/tanstack-hono my-app

# Navigate to your project
cd my-app

# Run the interactive setup script
bash scripts/setup.sh

# Clone the template
npx degit bskimball/tanstack-hono my-app

# Navigate to ...

TanStack Router + Hono SSR Template

A modern, production-ready full-stack React application template combining TanStack Router with Hono for server-side rendering. This setup delivers fast, SEO-friendly applications with excellent developer experience.

🏃‍♂️ Quick Start

Option 1: Using the Setup Script (Recommended)

# Clone the template
npx degit bskimball/tanstack-hono my-app

# Navigate to your project
cd my-app

# Run the interactive setup script
bash scripts/setup.sh

The setup script will:

• Update project name in package.json
• Create .env file from .env.example
• Install dependencies (optional)
• Initialize git repository (optional)

Option 2: Manual Setup

# Clone the template
npx degit bskimball/tanstack-hono my-app

# Navigate to your project
cd my-app

# Copy environment file
cp .env.example .env

# Install dependencies
npm install

# Start development server
npm run dev

Open http://localhost:3000 to see your app running!

Health Check: http://localhost:3000/api/health

🚀 Features

• 🗺 TanStack Router: Type-safe, file-based routing with powerful data loading
• ⚡ Hono SSR: Ultra-fast server-side rendering with minimal overhead
• 🔥 Vite: Lightning-fast development with Hot Module Replacement
• 📘 TypeScript: Full type safety across client and server
• 🎨 Tailwind CSS: Modern utility-first CSS framework
• 🧹 Biome: Fast linting, formatting, and code quality
• 🧪 Vitest: Fast unit testing with great DX

📁 Architecture

src/
├── components/
│   └── Header.tsx            # Reusable UI components
├── routes/                   # File-based routing (auto-generated)
│   ├── __root.tsx            # Root layout component
│   ├── index.tsx             # Home page route
│   ├── about.tsx             # About page route
│   └── -test.ts              # Test route utilities
├── entry-client.tsx          # Client-side hydration entry
├── entry-server.tsx          # Hono server with SSR setup
├── router.tsx                # Router configuration
└── styles.css                # Global styles

🛠 Development

npm run dev    # Start development server
npm run build  # Build for production
npm start      # Start production server
npm run test   # Run tests
npm run check  # Lint and format code

🔄 SSR Flow

1. Request: Browser requests a URL
2. Server: Hono matches route and runs TanStack Router SSR
3. Render: React components render to HTML string
4. Response: Full HTML sent to browser with embedded data
5. Hydration: Client-side React takes over for SPA navigation

🗺 File-Based Routing

Routes are automatically generated from files in src/routes/:

// src/routes/about.tsx
import { createFileRoute } from "@tanstack/react-router";

export const Route = createFileRoute("/about")({
component: AboutPage,
});

function AboutPage() {
return <div>About us!</div>;
}

🔗 Navigation

import { Link } from "@tanstack/react-router";

<Link to="/about">About</Link>

📊 Data Loading

export const Route = createFileRoute("/users")({
loader: async () => {
const users = await fetch("/api/users").then((r) => r.json());
return { users };
},
component: UsersPage,
});

function UsersPage() {
const { users } = Route.useLoaderData();
return (
<ul>
{users.map((user) => (
<li key={user.id}>{user.name}</li>
))}
</ul>
);
}

🏠 Layouts with SSR

The root layout (src/routes/__root.tsx) wraps all pages:

import { Outlet, createRootRoute } from "@tanstack/react-router";
import { Header } from "../components/Header";

export const Route = createRootRoute({
component: RootLayout,
});

function RootLayout() {
return (
<>
<Header />
<main>
<Outlet />
</main>
</>
);
}

⚡ Performance Benefits

SSR Advantages:

• SEO: Fully rendered HTML for search engines
• LCP: Faster Largest Contentful Paint
• Progressive Enhancement: Works without JavaScript
• Social Sharing: Rich preview cards with meta tags

Hono Benefits:

• Small Bundle: Minimal server overhead
• Edge Ready: Deploy to Cloudflare Workers, etc.
• Fast Startup: Quick cold start times

🐳 Docker Support

Using Docker

# Build and run production
docker-compose up app

# Development with hot reload
docker-compose --profile dev up dev

Building the Image

docker build -t tanstack-hono .
docker run -p 3000:3000 tanstack-hono

🚀 Deployment

Build for Production

npm run build
npm start

Deploy to:

• Docker: Use included Dockerfile and docker-compose.yml
• Vercel/Netlify: Serverless functions
• Railway/Render: Container deployments
• Cloudflare Workers: Edge runtime
• VPS: With PM2 + Nginx

See ARCHITECTURE.md for detailed deployment strategies.

📚 Documentation

• AGENTS.md - Guide for AI agents working with this codebase
• CLAUDE.md - Claude-specific context and patterns
• ARCHITECTURE.md - Deep dive into system design
• CONTRIBUTING.md - Contribution guidelines
• SECURITY.md - Security policy and best practices

🤖 AI-Friendly

This template includes comprehensive documentation for AI coding assistants:

• .cursorrules for Cursor IDE
• AGENTS.md for general AI agent guidelines
• CLAUDE.md for Claude-specific context

📖 Learn More

• TanStack Router - Type-safe routing
• Hono - Ultrafast web framework
• SSR Guide - TanStack Router SSR
• Vite SSR - Vite server-side rendering

📄 License

MIT License - see LICENSE file for details

🤝 Contributing

Contributions are welcome! Please read CONTRIBUTING.md for guidelines.