0
Fork 0
mirror of https://github.com/TanStack/router.git synced 2026-11-16 19:38:07 +00:00
router/examples/react/start-bun
Brenley Dueck adc6ed5712 Merge remote-tracking branch 'upstream/main' into solid-router-v2-pre
# Conflicts:
#	benchmarks/client-nav/package.json
#	examples/solid/authenticated-routes-firebase/package.json
#	examples/solid/authenticated-routes/package.json
#	examples/solid/basic-default-search-params/package.json
#	examples/solid/basic-devtools-panel/package.json
#	examples/solid/basic-file-based/package.json
#	examples/solid/basic-non-nested-devtools/package.json
#	examples/solid/basic-solid-query-file-based/package.json
#	examples/solid/basic-solid-query/package.json
#	examples/solid/basic-ssr-file-based/package.json
#	examples/solid/basic-ssr-streaming-file-based/package.json
#	examples/solid/basic-virtual-file-based/package.json
#	examples/solid/basic-virtual-inside-file-based/package.json
#	examples/solid/basic/package.json
#	examples/solid/deferred-data/package.json
#	examples/solid/i18n-paraglide/package.json
#	examples/solid/kitchen-sink-file-based/package.json
#	examples/solid/kitchen-sink-solid-query-file-based/package.json
#	examples/solid/kitchen-sink-solid-query/package.json
#	examples/solid/kitchen-sink/package.json
#	examples/solid/large-file-based/package.json
#	examples/solid/location-masking/package.json
#	examples/solid/navigation-blocking/package.json
#	examples/solid/quickstart-esbuild-file-based/package.json
#	examples/solid/quickstart-file-based/package.json
#	examples/solid/quickstart-rspack-file-based/package.json
#	examples/solid/quickstart-webpack-file-based/package.json
#	examples/solid/quickstart/package.json
#	examples/solid/router-monorepo-simple-lazy/package.json
#	examples/solid/router-monorepo-simple-lazy/packages/router/package.json
#	examples/solid/router-monorepo-simple/package.json
#	examples/solid/router-monorepo-simple/packages/router/package.json
#	examples/solid/router-monorepo-solid-query/package.json
#	examples/solid/router-monorepo-solid-query/packages/router/package.json
#	examples/solid/scroll-restoration/package.json
#	examples/solid/search-validator-adapters/package.json
#	examples/solid/start-basic-auth/package.json
#	examples/solid/start-basic-authjs/package.json
#	examples/solid/start-basic-cloudflare/package.json
#	examples/solid/start-basic-netlify/package.json
#	examples/solid/start-basic-nitro/package.json
#	examples/solid/start-basic-solid-query/package.json
#	examples/solid/start-basic-static/package.json
#	examples/solid/start-basic/package.json
#	examples/solid/start-bun/package.json
#	examples/solid/start-convex-better-auth/package.json
#	examples/solid/start-counter/package.json
#	examples/solid/start-i18n-paraglide/package.json
#	examples/solid/start-large/package.json
#	examples/solid/start-streaming-data-from-server-functions/package.json
#	examples/solid/start-supabase-basic/package.json
#	examples/solid/start-tailwind-v4/package.json
#	examples/solid/view-transitions/package.json
#	examples/solid/with-framer-motion/package.json
#	examples/solid/with-trpc/package.json
#	package.json
#	packages/solid-router/CHANGELOG.md
#	packages/solid-router/package.json
#	packages/solid-start-client/CHANGELOG.md
#	packages/solid-start-client/package.json
#	packages/solid-start-server/CHANGELOG.md
#	packages/solid-start-server/package.json
#	packages/solid-start/CHANGELOG.md
#	packages/solid-start/package.json
#	pnpm-lock.yaml
#	pnpm-workspace.yaml
History 2026-07-04 06:24:24 -05:00
..
.devcontainer docs: add devcontainer.json to all e2e/examples (#6972) 2026-03-18 15:43:14 +01:00
.vscode docs: add Bun production server guide for TanStack Start (#5237) 2025-09-27 01:01:49 +02:00
public docs: add Bun production server guide for TanStack Start (#5237) 2025-09-27 01:01:49 +02:00
src Merge branch 'main' into solid-router-main-merge2 2026-06-13 15:54:31 -05:00
.gitignore docs: add Bun production server guide for TanStack Start (#5237) 2025-09-27 01:01:49 +02:00
.prettierignore docs: add Bun production server guide for TanStack Start (#5237) 2025-09-27 01:01:49 +02:00
eslint.config.js docs: add Bun production server guide for TanStack Start (#5237) 2025-09-27 01:01:49 +02:00
package.json ci: Version Packages (#7676) 2026-07-01 23:33:19 +02:00
prettier.config.js docs: add Bun production server guide for TanStack Start (#5237) 2025-09-27 01:01:49 +02:00
README.md docs(examples): standardize the READMEs for the React examples (#6014) 2025-12-07 01:39:44 +13:00
server.ts examples: fix Bun server static routes from using the wrong path separator on Windows (#5285) 2025-09-29 00:17:02 +02:00
tsconfig.json chore: merge main to solid v2 (#7105) 2026-04-05 20:56:19 +02:00
vite.config.ts docs: update examples/e2e to vite 8 (#6958) 2026-03-17 20:37:11 +01:00

TanStack Start + Bun Production Server

An optimized production server for TanStack Start applications using Bun, implementing intelligent static asset loading with configurable memory management.

Start a new project based on this example

To start a new project based on this example, run:

npx gitpick TanStack/router/tree/main/examples/react/start-bun start-bun

🚀 Features

  • Hybrid Loading Strategy: Small files are preloaded into memory, large files are served on-demand
  • Configurable File Filtering: Include/Exclude patterns for precise control
  • Memory-efficient Response Generation: Optimized for high performance
  • Production-ready Caching Headers: Automatic Cache-Control headers for optimal performance
  • Detailed Logging: Vite-like output for better overview

📦 Installation

This project was created with TanStack Start:

bunx create-start-app@latest

Install dependencies:

bun install

🏃‍♂️ Development

For development:

bun run dev

🔨 Production Build

Build the application for production:

bun run build

🚀 Production Server with server.ts

Quick Start - Use in Your Project

You can easily use this production server in your own TanStack Start project:

  1. Copy the server.ts file into your project root
  2. Build your project with bun run build
  3. Start the server directly with:
    bun run server.ts
    

Or add it to your package.json scripts:

{
  "scripts": {
    "start": "bun run server.ts"
  }
}

Then run with:

bun run start

Server Features

The server.ts implements a high-performance production server with the following features:

1. Intelligent Asset Loading

The server automatically decides which files to preload into memory and which to serve on-demand:

  • In-Memory Loading: Small files (default < 5MB) are loaded into memory at startup
  • On-Demand Loading: Large files are loaded from disk only when requested
  • Optimized Performance: Frequently used assets are served from memory

2. Configuration via Environment Variables

# Server Port (default: 3000)
PORT=3000

# Maximum file size for in-memory loading (in bytes, default: 5MB)
STATIC_PRELOAD_MAX_BYTES=5242880

# Include patterns (comma-separated, only these files will be preloaded)
STATIC_PRELOAD_INCLUDE="*.js,*.css,*.woff2"

# Exclude patterns (comma-separated, these files will be excluded)
STATIC_PRELOAD_EXCLUDE="*.map,*.txt"

# Enable detailed logging
STATIC_PRELOAD_VERBOSE=true

Example Configurations

Minimal Memory Footprint

# Preload only critical assets
STATIC_PRELOAD_MAX_BYTES=1048576 \
STATIC_PRELOAD_INCLUDE="*.js,*.css" \
STATIC_PRELOAD_EXCLUDE="*.map,vendor-*" \
bun run start

Maximum Performance

# Preload all small assets
STATIC_PRELOAD_MAX_BYTES=10485760 \
bun run start

Debug Mode

# With detailed logging
STATIC_PRELOAD_VERBOSE=true \
bun run start

Server Output

The server displays a clear overview of all loaded assets at startup:

📦 Loading static assets from ./dist/client...
   Max preload size: 5.00 MB
   Include patterns: *.js,*.css,*.woff2

📁 Preloaded into memory:
   /assets/index-a1b2c3d4.js           45.23 kB │ gzip:  15.83 kB
   /assets/index-e5f6g7h8.css           12.45 kB │ gzip:   4.36 kB

💾 Served on-demand:
   /assets/vendor-i9j0k1l2.js          245.67 kB │ gzip:  86.98 kB

✅ Preloaded 2 files (57.68 KB) into memory
ℹ️  1 files will be served on-demand (1 too large, 0 filtered)

🚀 Server running at http://localhost:3000

Getting Started

From your terminal:

pnpm install
pnpm dev

Build

Build for production:

pnpm build

Production

Start the production server:

pnpm start

Testing

This project uses Vitest for testing. You can run the tests with:

bun run test

Styling

This project uses Tailwind CSS for styling.

Linting & Formatting

This project uses eslint and prettier for linting and formatting. Eslint is configured using tanstack/eslint-config. The following scripts are available:

bun run lint
bun run format
bun run check