Image Pipeline Playground
Image Pipes — Desktop (Electron)
One-window desktop app: Electron starts the FastAPI backend, waits for health, then loads the UI.
Easy path for users
Download prebuilt installers from GitHub Releases.
Or build an installer yourself (Windows NSIS / macOS DMG / Linux AppImage), then distribute desktop/release/*.
# from repo root — needs Node.js, npm, and uv
npm run install:all
npm run build:desktop
Installers land in desktop/release/. End users do not need Python or Node.
GitHub Actions builds Windows / Linux / macOS installers on main and publishes them when you push a v* tag (see .github/workflows/desktop.yml).
Installer version comes from the git tag (v0.2.0 → 0.2.0) via scripts/build-desktop.mjs. Override with IMAGE_PIPES_VERSION if needed.
Developer day-to-day
Terminal A — not required if you use the desktop shell:
cd backend && uv sync && uv run python run_server.py
cd frontend && npm run build # once, so FastAPI can serve the UI
Or run everything from Electron (spawns backend + Vite for you):
cd backend && uv sync
cd ../frontend && npm install
cd ../desktop && npm install
cd .. && npm run desktop
npm run desktop launches Electron with --dev: it starts the FastAPI backend, starts the Vite frontend (hot reload), and loads that URL. Edit React code and the window updates without rebuilding.
npm run desktop:start (no --dev) serves the built frontend/dist instead — run npm run build:frontend first for that path.
What gets packaged
- Vite production build →
frontend/dist - PyInstaller onedir sidecar →
desktop/resources/server/image-pipes-server(.exe) - electron-builder wraps Electron + sidecar + examples
Runtime data (cache, uploads, downloads, asset registry) goes under the OS userData folder, not Program Files.
Desktop file I/O
- Load Images uses native open-file / open-folder dialogs and registers local paths as asset batches (no copy into
uploads/). - Save Image can write directly to a user-picked output folder; ZIP download remains a fallback when no folder is set.
- The preload bridge exposes
window.imagePipesDesktop(openImages,openFolder,pickFolder,revealInFolder).