Getting Started

Bunstone is a decorator-based framework for Bun, inspired by NestJS. It provides a structured way to build scalable and maintainable APIs.

Installation

You can scaffold a new project using our CLI:

bunx @grupodiariodaregiao/bunstone new my-app
# or shorthand
bunx @grupodiariodaregiao/bunstone my-app

Basic Setup

Bunstone projects follow a modular structure. Here's a basic setup:

src/main.ts

import "reflect-metadata";
import { AppStartup } from "@grupodiariodaregiao/bunstone";
import { AppModule } from "./app.module";

async function bootstrap() {
  const app = AppStartup.create(AppModule);
  app.listen(3000);
}

bootstrap();

src/app.module.ts

import { Module } from "@grupodiariodaregiao/bunstone";
import { AppController } from "./controllers/app.controller";

@Module({
  controllers: [AppController],
})
export class AppModule {}

Running the App

bun dev

Your app will be running at http://localhost:3000.

Full Example

Check out a complete standalone example of a basic application:

import { Module, Controller, Get, Injectable, AppStartup } from "../../index";

@Injectable()
class AppService {
  getHello(): string {
    return "Hello from Bunstone!";
  }
}

@Controller()
class AppController {
  constructor(private readonly appService: AppService) {}

  @Get()
  getHello(): string {
    return this.appService.getHello();
  }
}

@Module({
  controllers: [AppController],
  providers: [AppService],
})
class AppModule {}

const app = AppStartup.create(AppModule);
app.listen(3000, () => {
  console.log("Basic app is running on http://localhost:3000");
});

See it on GitHub