Skip to content

Getting Started

Prerequisites

  • Rust (with cargo) — Install Rust
  • Node.js (v18+)
  • pnpmnpm install -g pnpm

Install and run

Terminal window
git clone https://github.com/mcp-tool-shop-org/studioflow.git
cd studioflow
pnpm install
pnpm dev

This launches the Tauri v2 desktop window with the full workspace (canvas, layers panel, inspector, toolbar, and project bar).

Development commands

CommandPurpose
pnpm devLaunch Tauri dev window with hot reload
pnpm buildBuild all packages (domain, state, desktop)
pnpm testRun Vitest across all packages (236 tests)
pnpm typecheckTypeScript check across the monorepo
pnpm verifyTypecheck + test in one pass

Monorepo structure

StudioFlow uses pnpm workspaces with three packages:

PackagePathPurpose
Desktop appapps/desktopTauri v2 + React desktop application with Rust backend
Domain typespackages/domainPure TypeScript types — layer, project, command, viewport, history, selection, persistence, workspace, color
State storespackages/stateZustand stores that implement domain behavior — document, selection, viewport, command, history, persistence, workspace, plus a cross-store dirty tracker

Project files

StudioFlow saves projects as .studioflow JSON files containing the schema version, project metadata, and layer data. Recent projects are tracked locally and shown in the ProjectBar for quick access.