MELOPHOS server

The self-hostable MELOPHOS backend: practice sessions, note events, song import and integrations, plus the Docker Compose stack that runs it all.

Note

This is a read-only copy published from melophos/melophos. Open issues and pull requests there.

Run the whole stack

cd deploy
cp .env.example .env        # then replace every change-me value
docker compose up -d

The API is on http://localhost:8000 with interactive documentation at /docs.

Develop the API alone

python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
uvicorn app.main:app --reload

Checks

ruff check .
ruff format --check .
mypy
pytest

Layout

Folder	Contents
app/	FastAPI application: routes, schemas, statistics, storage and integrations
worker/	Background import jobs: MIDI, audio transcription and tutorial video reading
db/	Postgres and TimescaleDB schema migrations
deploy/	Docker Compose stack, MQTT broker and monitoring configuration
tests/	Pytest suite

Licence

GNU Affero General Public License v3.0 or later, see LICENSE. If you run a modified version as a network service, the licence requires offering your users its source.