home / skills / secondsky / claude-skills / bun-nextjs

bun-nextjs skill

/plugins/bun/skills/bun-nextjs

This skill helps you run Next.js apps on Bun for faster development, builds, and production readiness.

npx playbooks add skill secondsky/claude-skills --skill bun-nextjs

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
5.8 KB
---
name: Bun Next.js
description: This skill should be used when the user asks about "Next.js with Bun", "Bun and Next", "running Next.js on Bun", "Next.js development with Bun", "create-next-app with Bun", or building Next.js applications using Bun as the runtime.
version: 1.0.0
---

# Bun Next.js

Run Next.js applications with Bun for faster development and builds.

## Quick Start

```bash
# Create new Next.js project with Bun
bunx create-next-app@latest my-app
cd my-app

# Install dependencies
bun install

# Development
bun run dev

# Build
bun run build

# Production
bun run start
```

## Project Setup

### package.json

```json
{
  "scripts": {
    "dev": "next dev --turbo",
    "build": "next build",
    "start": "next start",
    "lint": "next lint"
  },
  "dependencies": {
    "next": "^16.1.1",
    "react": "^19.2.3",
    "react-dom": "^19.2.3"
  }
}
```

### Use Bun as Runtime

```json
{
  "scripts": {
    "dev": "bun --bun next dev",
    "build": "bun --bun next build",
    "start": "bun --bun next start"
  }
}
```

The `--bun` flag forces Next.js to use Bun's runtime instead of Node.js.

## Configuration

### next.config.js

```javascript
/** @type {import('next').NextConfig} */
const nextConfig = {
  // Enable experimental features
  experimental: {
    // Turbopack (faster dev)
    turbo: {},
  },

  // Server-side Bun APIs
  serverExternalPackages: ["bun:sqlite"],

  // Webpack config (if needed)
  webpack: (config, { isServer }) => {
    if (isServer) {
      // Allow Bun-specific imports
      config.externals.push("bun:sqlite", "bun:ffi");
    }
    return config;
  },
};

module.exports = nextConfig;
```

## Using Bun APIs in Next.js

### Server Components

```typescript
// app/page.tsx (Server Component)
import { Database } from "bun:sqlite";

export default async function Home() {
  const db = new Database("data.sqlite");
  const users = db.query("SELECT * FROM users").all();
  db.close();

  return (
    <div>
      {users.map((user) => (
        <p key={user.id}>{user.name}</p>
      ))}
    </div>
  );
}
```

### API Routes

```typescript
// app/api/users/route.ts
import { Database } from "bun:sqlite";

export async function GET() {
  const db = new Database("data.sqlite");
  const users = db.query("SELECT * FROM users").all();
  db.close();

  return Response.json(users);
}

export async function POST(request: Request) {
  const body = await request.json();

  const db = new Database("data.sqlite");
  db.run("INSERT INTO users (name) VALUES (?)", [body.name]);
  db.close();

  return Response.json({ success: true });
}
```

### File Operations

```typescript
// app/api/files/route.ts
export async function GET() {
  const file = Bun.file("./data/config.json");
  const config = await file.json();

  return Response.json(config);
}

export async function POST(request: Request) {
  const data = await request.json();
  await Bun.write("./data/config.json", JSON.stringify(data, null, 2));

  return Response.json({ saved: true });
}
```

## Server Actions

```typescript
// app/actions.ts
"use server";

import { Database } from "bun:sqlite";
import { revalidatePath } from "next/cache";

export async function createUser(formData: FormData) {
  const name = formData.get("name") as string;

  const db = new Database("data.sqlite");
  db.run("INSERT INTO users (name) VALUES (?)", [name]);
  db.close();

  revalidatePath("/users");
}

export async function deleteUser(id: number) {
  const db = new Database("data.sqlite");
  db.run("DELETE FROM users WHERE id = ?", [id]);
  db.close();

  revalidatePath("/users");
}
```

## Middleware

```typescript
// middleware.ts
import { NextResponse } from "next/server";
import type { NextRequest } from "next/server";

export function middleware(request: NextRequest) {
  // Check auth
  const token = request.cookies.get("token");

  if (!token && request.nextUrl.pathname.startsWith("/dashboard")) {
    return NextResponse.redirect(new URL("/login", request.url));
  }

  return NextResponse.next();
}

export const config = {
  matcher: ["/dashboard/:path*"],
};
```

## Environment Variables

```bash
# .env.local
DATABASE_URL=./data.sqlite
API_SECRET=your-secret-key
```

```typescript
// Access in server components/actions
const dbUrl = process.env.DATABASE_URL;
const secret = process.env.API_SECRET;

// Expose to client (prefix with NEXT_PUBLIC_)
// .env.local
NEXT_PUBLIC_API_URL=https://api.example.com
```

## Deployment

### Build for Production

```bash
bun run build
bun run start
```

### Docker

```dockerfile
FROM oven/bun:1

WORKDIR /app

COPY package.json bun.lockb ./
RUN bun install --frozen-lockfile

COPY . .
RUN bun run build

EXPOSE 3000

CMD ["bun", "run", "start"]
```

### Vercel

```bash
# Install Vercel CLI
bun add -g vercel

# Deploy
vercel
```

Note: Vercel's edge runtime uses V8, not Bun. Bun APIs work in:
- Server Components (Node.js runtime)
- API Routes (Node.js runtime)
- Server Actions (Node.js runtime)

## Performance Tips

1. **Use Turbopack** for faster dev:
   ```bash
   bun run dev --turbo
   ```

2. **Prefer Server Components** - Less JavaScript sent to client

3. **Use Bun SQLite** instead of external databases for simple apps

4. **Enable compression**:
   ```javascript
   // next.config.js
   module.exports = {
     compress: true,
   };
   ```

## Common Errors

| Error | Cause | Fix |
|-------|-------|-----|
| `Cannot find bun:sqlite` | Wrong runtime | Use `bun --bun next dev` |
| `Module not found` | Missing dependency | Run `bun install` |
| `Hydration mismatch` | Server/client diff | Check data fetching |
| `Edge runtime error` | Bun API on edge | Use Node.js runtime |

## When to Load References

Load `references/app-router.md` when:
- App Router patterns
- Route groups
- Parallel routes

Load `references/caching.md` when:
- Data caching strategies
- Revalidation patterns
- Static generation

Overview

This skill explains how to run Next.js applications on the Bun runtime to speed development and builds. It provides practical setup snippets, Bun-specific configuration, examples using Bun APIs (sqlite, file I/O), and deployment tips for Docker and Vercel. Use it to migrate, bootstrap, or optimize Next.js projects with Bun as the runtime.

How this skill works

The skill inspects project setup, package scripts, and next.config.js to ensure Next.js runs under Bun (using the --bun flag). It shows where to use Bun APIs in server components, API routes, server actions, and middleware. It also covers build and production steps, Docker hints, environment variable usage, and common runtime errors with fixes.

When to use it

  • You want faster local dev and builds using Bun instead of Node.js.
  • Bootstrapping a new Next.js app with bunx create-next-app for performance testing.
  • Using Bun-specific APIs like bun:sqlite or Bun.file in server components or API routes.
  • Deploying a Next.js app inside a Bun-based Docker image or testing Bun locally before cloud deployment.
  • Migrating an existing Next.js project to Bun for quicker feedback loops.

Best practices

  • Add Bun-aware scripts (bun --bun next dev/build/start) so Next.js runs under Bun explicitly.
  • Prefer Server Components and Server Actions to minimize client JS and leverage Bun APIs securely.
  • Enable Turbopack for faster dev iterations (next dev --turbo).
  • List Bun-only packages in serverExternalPackages and add Bun externals in webpack when isServer is true.
  • Keep secrets in .env.local and expose only NEXT_PUBLIC_ variables to the client.

Example use cases

  • Create a new Next.js app with bunx and run bun install then bun run dev for fast iteration.
  • Use bun:sqlite in app server components to query local SQLite without an external DB for small apps or prototypes.
  • Implement API routes that read/write files with Bun.file and Bun.write for configuration endpoints.
  • Build and containerize with oven/bun Docker image, run bun run build, and serve with bun run start in production.
  • Use server actions to insert/delete rows in Bun sqlite and trigger revalidation with revalidatePath.

FAQ

Do Bun APIs work in all Next.js runtimes?

No. Bun APIs require the Node.js-style server runtime in Next.js (server components, API routes, server actions). They won't work in the Edge runtime, which uses V8.

How do I force Next.js to use Bun?

Use Bun-aware scripts like bun --bun next dev / build / start or invoke via bunx so Next.js picks the Bun runtime. Also ensure bun install has run.