Skip to content

README.md

Latest commit

 

History

History
38 lines (28 loc) · 893 Bytes

README.md

File metadata and controls

38 lines (28 loc) · 893 Bytes
Raw

Modly — FastAPI Backend

Local Python server started and managed by Electron.

Setup

cd api
python -m venv .venv
# Windows
.venv\Scripts\activate
# macOS/Linux
source .venv/bin/activate

pip install -r requirements.txt

Run (development)

uvicorn main:app --host 127.0.0.1 --port 8765 --reload

Key endpoints

Method Path Description
GET /health Health check (used by Electron to detect readiness)
GET /model/status Model download / load status
GET /model/download SSE stream of download progress
POST /generate/from-image Start image-to-3D job
GET /generate/status/{job_id} Poll job status

Model

Default: TripoSR (stabilityai/TripoSR, ~2.4 GB) Downloaded on first launch to ~/.modly/models/TripoSR/. To change model: edit services/model_manager.py.