Skip to content

Tutorial

Welcome to the Honey Badgeria tutorial. This section walks you through everything you need to get started, from installation to running your first full-stack project.

What You'll Learn

  1. Quick Start — Install, scaffold, and start prompting in under two minutes.
  2. Installation — Install Honey Badgeria and its optional dependencies.
  3. First Steps — Scaffold a project and understand the file structure.
  4. Defining Flows — Write your first YAML flow definition.
  5. Running & Inspecting — Execute flows, inspect topology, visualize DAGs.
  6. Testing Flows — Use the built-in testing framework with mocks and assertions.
  7. FastAPI Integration — Turn your flows into REST API endpoints.
  8. Full-Stack Project — Build a monorepo with backend (FastAPI) and frontend (Next.js + reactive graphs).

Prerequisites

  • Python 3.9+
  • Node.js 18+ and npm (only if using the frontend/monorepo features)

Note

HBIA focuses on architecture. If you scaffold a FastAPI or Next.js project, install those frameworks in your app environment.

Project Types

HBIA can scaffold three kinds of projects:

Command What You Get
hbia init my_project Plain backend — flows, vertices, tests
hbia init my_api --framework fastapi FastAPI project with HBIA graph execution
hbia init my_app --framework monorepo Full-stack: back/ (FastAPI) + front/ (Next.js)

Choose the type that fits your use case and follow the corresponding tutorial section.