Installation

Get Bunty up and running on your machine in minutes.

Prerequisites

Before installing Bunty, make sure you have Bun installed:

• Bun - Version 1.0 or higher (Install Bun)

That’s it! Bunty is built for Bun and doesn’t require Node.js or any other runtime.

Creating a New Project

The easiest way to get started is with the create command:

bun create bunty app
cd app

This will scaffold a new Bunty project with everything you need to get started.

This will scaffold a new Bunty project with the following structure:

app/
├── src/
│   ├── controllers/
│   ├── services/
│   └── index.ts
├── config/
│   └── app.ts
├── tests/
├── package.json
├── tsconfig.json
└── bunfig.toml

Install Dependencies

After creating your project, install the dependencies:

bun install

Start Development Server

Start your application in development mode:

bun run dev

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

Manual Installation

If you prefer to set up your project manually, install the core packages:

bun add @bunty/core @bunty/http

Bunty comes with TypeScript support out of the box - no additional configuration needed!

Bunty comes with TypeScript support out of the box - no additional configuration needed!

Optional: Database Support

Bunty includes optional ORM support. If you want to use a database, install the ORM package and the appropriate database driver:

Install ORM

bun add @bunty/orm

Database Drivers

Choose and install the driver for your database:

PostgreSQL

bun add pg

MySQL

bun add mysql2

SQLite

bun add better-sqlite3

MongoDB

bun add mongodb

Note: Database support is completely optional. You can build great applications with just @bunty/core and @bunty/http!

Next Steps

Now that you have Bunty installed, you’re ready to build your first application:

• Quick Start - Build your first Bunty app in 10 minutes
• Configuration - Learn about configuring your Bunty application