Installation¶

Prerequisites¶

Python 3.11+
uv (Python package manager)
Node.js 20+
Docker Desktop or Podman (for container management features)

Quick Start (Development)¶

git clone https://github.com/joshuajerome/cutip-desktop.git
cd cutip-desktop

Backend¶

cd backend
uv sync
uv run python -m uvicorn app.main:app --reload --port 8000

Frontend¶

cd frontend
npm install
npm run dev

Electron (optional)¶

cd electron
npm install
npm start

Frontend: http://localhost:3000 (Vite dev server)
Backend API: http://localhost:8000/api/health
Swagger docs: http://localhost:8000/docs

The Vite dev server proxies /api and /ws requests to the backend on port 8000 automatically.

Production Build¶

python scripts/build.py

This runs three stages: 1. Frontend: npm ci && npm run build → frontend/dist/ 2. Backend: PyInstaller bundles Python + frontend into dist/backend/ 3. Electron: electron-builder → DMG (macOS), NSIS (Windows), AppImage (Linux)

Download¶

Pre-built desktop apps are available on the Releases page.