Files
mediahive/docs/development.md
T
2026-06-03 00:41:52 +00:00

1.5 KiB

Development

This document covers the developer-facing ways to run MediaHive locally. The main README.md covers end-user startup across platforms (portable ZIPs on Windows/macOS, uvx --from mediahive[gui] mediahive on Linux/other).

Requirements

  • Python 3.14+
  • uv
  • Node.js 18+

Install Dependencies

uv sync --extra gui --group dev
cd frontend
npm install

Run The Backend Directly

uv run mediahive /path/to/media/folder

This starts the FastAPI backend and serves the built frontend.

Run Frontend + Backend In Development

uv run scripts/devserver.py /path/to/media/folder

This starts the FastAPI backend with auto-reload plus the Vite frontend dev server.

Run The Desktop App In Development

uv run --extra gui python -m mediahive.winmain /path/to/media/folder

This launches the same pywebview-based desktop flow used by the Windows build.

Migrate Existing Index Snapshots

uv run python scripts/indexmigr.py /path/to/media/root --write

This applies versioned snapshot migrations to .mediahive/index.json outside the main application. Use it before starting a newer build against an older index.

Notes

  • The selected media folder is scanned continuously by the backend.
  • The desktop app remembers the chosen folder between launches.
  • HTTP and WebSocket endpoints are documented in API.md.
  • MPC-BE integration details (Windows only) live in mpc-be.md.