template

Features

• TypeScript - For type safety and improved developer experience
• TanStack Router - File-based routing with full type safety
• TailwindCSS - Utility-first CSS for rapid UI development
• Shared UI package - shadcn/ui primitives live in packages/ui
• Hono - Lightweight, performant server framework
• tRPC - End-to-end type-safe APIs
• workers - Runtime environment
• Drizzle - TypeScript-first ORM
• PostgreSQL - Database engine
• Authentication - Better-Auth
• Husky - Git hooks for code quality
• Oxlint - Oxlint + Oxfmt (linting & formatting)
• Turborepo - Optimized monorepo build system

Getting Started

First, install the dependencies:

bun install

Database Setup

This project uses PostgreSQL with Drizzle ORM.

1. Make sure you have a PostgreSQL database set up.

2. Update your apps/server/.env file with your PostgreSQL connection details.

3. Apply the schema to your database:

bun run db:push

Then, run the development server:

bun run dev

Open http://localhost:3001 in your browser to see the web application. The API is running at http://localhost:3000.

UI Customization

React web apps in this stack share shadcn/ui primitives through packages/ui.

• Change design tokens and global styles in packages/ui/src/styles/globals.css
• Update shared primitives in packages/ui/src/components/*
• Adjust shadcn aliases or style config in packages/ui/components.json and apps/web/components.json

Add more shared components

Run this from the project root to add more primitives to the shared UI package:

npx shadcn@latest add accordion dialog popover sheet table -c packages/ui

Import shared components like this:

import { Button } from "@open-learn/ui/components/button";

Add app-specific blocks

If you want to add app-specific blocks instead of shared primitives, run the shadcn CLI from apps/web.

Deployment (Cloudflare via Alchemy)

• Dev: bun run dev
• Deploy: bun run deploy
• Destroy: bun run destroy

For more details, see the guide on Deploying to Cloudflare with Alchemy.

Git Hooks and Formatting

• Initialize hooks: bun run prepare
• Format and lint fix: bun run check

Project Structure

open-learn/
├── apps/
│   ├── web/         # Frontend application (React + TanStack Router)
│   └── server/      # Backend API (Hono, TRPC)
├── packages/
│   ├── ui/          # Shared shadcn/ui components and styles
│   ├── api/         # API layer / business logic
│   ├── auth/        # Authentication configuration & logic
│   └── db/          # Database schema & queries

Agent Docs

• AGENTS.md - repo-wide architecture and modular development rules
• apps/server/AGENTS.md - server transport and backend module rules
• apps/web/AGENTS.md - web feature and route composition rules
• packages/api/AGENTS.md - tRPC contract and service-layer rules
• packages/db/AGENTS.md - repository and persistence-layer rules
• packages/auth/AGENTS.md - auth configuration and integration rules
• packages/ui/AGENTS.md - shared UI primitive and styling rules

Available Scripts

• bun run dev: Start all applications in development mode
• bun run build: Build all applications
• bun run dev:web: Start only the web application
• bun run dev:server: Start only the server
• bun run check-types: Check TypeScript types across all apps
• bun run db:push: Push schema changes to database
• bun run db:generate: Generate database client/types
• bun run db:migrate: Run database migrations
• bun run db:studio: Open database studio UI
• bun run check: Run Oxlint and Oxfmt