GuideStart
Edit this page

Start

Installation and Setup

Install Bun, prepare a project directory, and boot the framework with a minimal Bun-first setup.

installbunsetup

This page gets a fresh Task Tracker workspace to the point where you can start writing route files.

Minimal setup

bun --version
mkdir task-tracker
cd task-tracker
rbssr init
bun install
bun run dev

Open http://127.0.0.1:3000 after the dev server starts.

If you are working from this repository

git clone [email protected]:react-formation/react-bun-ssr.git
cd react-bun-ssr
bun install
bun run docs:dev

That runs the documentation site built with the framework itself.

What rbssr init gives you

  • package.json with Bun scripts and runtime dependencies
  • tsconfig.json with Bun-friendly TypeScript defaults
  • .gitignore with starter ignore rules
  • app/root.tsx as the document shell
  • app/root.module.css with default starter styling
  • app/routes/ for file-based pages and APIs
  • app/public/ for static assets
  • rbssr.config.ts for runtime configuration

First files to verify

package.json
tsconfig.json
.gitignore
app/
  root.tsx
  root.module.css
  routes/
    index.tsx
    api/
      health.ts
  middleware.ts
  public/
    favicon.svg
rbssr.config.ts

Rules

  • Bun >= 1.3.10 is the baseline.
  • The framework expects Bun for dev, build, and production runtime.
  • Route code that also hydrates in the browser should avoid top-level server-only imports.

Next step

Build the first real page in Quick Start.