Getting Started

Prerequisites

• Bun >= 1.2
• Node.js >= 18 (for non-Bun runtimes)

curl -fsSL https://bun.sh/install | bash

Installation

bunx create-rune my-app
cd my-app
bun install
bun run dev

Manual Setup

mkdir my-app && cd my-app
bun init -y
bun add @rune/core @rune/decorators

Your First App

1. Create a Controller

src/controllers/hello.controller.ts

import { Controller, Get } from "@rune/decorators";

@Controller("/")
export class HelloController {
  @Get("/")
  hello() {
    return { message: "Hello, Rune!" };
  }
}

2. Create a Module

src/app.module.ts

import { Module } from "@rune/decorators";
import { HelloController } from "./controllers/hello.controller";

@Module({
  controllers: [HelloController],
  providers: [],
  imports: [],
  exports: [],
})
export class AppModule {}

3. Bootstrap

src/main.ts

import { createApp } from "@rune/core";
import { AppModule } from "./app.module";

const app = createApp();
app.registerModule(AppModule);
app.init();

Bun.serve({
  port: 3000,
  fetch: (req) => app.fetch(req),
});

console.log("Server running on http://localhost:3000");

4. Run

bun src/main.ts
# or with watch mode
bun --watch src/main.ts

Next Steps

• Learn about Decorators
• Add Validation
• Generate OpenAPI docs
• Deploy with Runtime Adapters