Welcome to the Guitarverse project!

we are a free open source project aimed at revolutionizing guitar practice!

Guitar verse aims to make guitar practice more sociable!

we included leaderboards, profiles, campaign modes and more

Get live feeback on your accuracy

Development Workflows

1) Local dev (UI + MIDI import)

Use this when working on normal UI/game features or MIDI import.

npm install
npm run dev

Open: http://localhost:3000

Notes:

• This keeps your existing workflow unchanged.
• MIDI import works without ffmpeg/ffprobe.
• If audio import is selected and required backend tools are unavailable on the server runtime, the app shows a server-side capability warning.

2) Local dev with audio import via Docker (recommended)

Use this when you need audio import. This Docker backend includes ffmpeg/ffprobe, Python + pip, demucs, and basic-pitch preinstalled.

docker compose up --build audio-import-backend

Open: http://localhost:3001

This container runs the backend + in-process import worker with audio tooling available. No manual install of transcription dependencies is required for teammates/end users when using this Docker workflow. At startup, the container pre-warms the configured Demucs model and reuses checkpoints from a persistent Docker volume (TORCH_HOME=/opt/torch-cache).

Stop it with:

docker compose down

Docker env notes

• docker-compose.yml reads .env.local.
• For Docker backend DB access, MONGODB_URI defaults to:
  • mongodb://host.docker.internal:27017/guitar-game
• You can override by setting DOCKER_MONGODB_URI before startup.
• Demucs runtime defaults:
  • DEMUCS_MODEL=htdemucs
  • TORCH_HOME=/opt/torch-cache (persisted by demucs_torch_cache volume)
  • PREWARM_DEMUCS_MODEL=1 (set 0 to skip startup prewarm)