RiserBob logoRiserBobv1.0.0
HomeDocsCLIRelease notes

Getting started

  • Introduction
  • Installation
  • Quick start
  • Project structure

Core concepts

  • Routing
  • Request
  • Responses
  • Error handling

Middleware

  • Middleware
  • Authentication
  • Logger and CORS

Data

  • Validation

Structure and tooling

  • Modules
  • CLI

Examples

  • Build a project
  • Mongoose
  • Drizzle ORM
  • Sequelize
  • JWT and cookies
  • File uploads

Packages

  • Cookies

Resources

  • Troubleshooting
  • Release notes
  • License
  • Security
  • Contributing
Getting started

Installation

Create a new RiserBob project, or add the framework to an existing Bun project.

Create a new project

The quickest way to start is the project template. It gives you a working server, a ready-made users module and the recommended folder structure.

Terminal
bun create riser-bob my-appcd my-appbun installbun run dev

The server runs on port 4000. Visit http://localhost:4000 to see Welcome to Bikini Bottom! 🍍.

Add to an existing project

Terminal
bun add riser-bob
The examples in these docs import from riser-bob. Adjust the import path if you reference the framework differently.

Scripts

The starter project comes with three scripts.

ScriptCommandWhat it does
bun run devbun run --watch src/index.tsRuns the server and restarts it on every change.
bun run startbun run src/index.tsRuns the server once.
bun run buildbun build src/index.ts --outdir dist --minifyBundles the app into dist/.

Environment variables

Bun loads a .env file from the project root automatically, so you can read values with process.env. The starter does not need any. The Build a project guide shows the variables a real app usually adds.

Never commit .env. Keep it in .gitignore and share a .env.example with placeholder values instead.
PreviousIntroductionNextQuick start

On this page

  • Create a new project
  • Add to an existing project
  • Scripts
  • Environment variables