ContributingDevelopment Setup

Development Setup

BioNodulo’s core engine, editor, and desktop app are open source (GPL-3). Contributions — bug fixes, new nodes, docs — are welcome. This page gets you a working development environment.

Prerequisites

  • Node.js 22+ and pnpm 9+ (the repo pins a packageManager).
  • Python 3.11+ for the engine and node SDK.
  • A container runtime (Docker or compatible) to run containerized nodes.
  • git.

Clone & install

git clone https://github.com/bionodulo/bionodulo.git
cd bionodulo
pnpm install

The repository is a monorepo (Turborepo). Common packages:

PathWhat it is
apps/desktopElectron desktop app
apps/webCloud web app / editor
apps/docsThis documentation site (Nextra)
packages/*Shared libraries (types, UI, SDK)

Run the apps

# Everything in dev mode
pnpm dev
 
# A single app
pnpm --filter @bionodulo/docs dev      # docs on :3001
pnpm --filter @bionodulo/web dev       # web app
pnpm --filter @bionodulo/desktop dev   # desktop app

Engine & node SDK (Python)

cd engine
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
pytest

Lint, typecheck, test

pnpm lint
pnpm build      # turbo-orchestrated build across packages
pnpm test

Next