Go to file
2026-07-07 02:24:46 +02:00
apps/apple Add offline resilience coverage 2026-06-19 04:08:36 +02:00
backend Remove Legacy storage readiness paths 2026-07-06 12:37:19 +02:00
docs Update VELODY_ROADMAP 2026-07-02 12:04:01 +02:00
infra Add Paddle configuration foundation 2026-07-02 13:38:20 +02:00
packages/apple Add offline resilience coverage 2026-06-19 04:08:36 +02:00
runtime version 1.0.0 2026-05-24 20:53:42 +02:00
.dockerignore Add root Docker ignore 2026-07-06 00:15:44 +02:00
.gitignore Edit Ignore local build artifacts 2026-06-20 08:08:59 +02:00
README.md Update READMEE 2026-07-07 02:24:46 +02:00

Velody

Velody is a private music ecosystem for personal use across macOS, iPhone, and a VPS backend.

The repository now includes a working backend plus Apple clients for local library upload, remote playback, iPhone sync, offline resilience, account foundation work, and early billing groundwork.

Repository Layout

  • apps/apple for the native Apple apps workspace
  • packages/apple for shared Swift packages
  • backend for the NestJS API and Prisma schema
  • infra for local Docker and deployment references
  • runtime for local development storage paths
  • docs/PROJECT_ENVIRONMENT_ARCHITECTURE.md as the functional source of truth

Requirements

  • Xcode 26+
  • Swift 5.9+
  • Node.js 20+
  • npm 10+
  • Docker Desktop

Local Backend Setup

  1. Copy the example environment file:
cp backend/.env.example backend/.env
  1. Start Postgres and the API:
docker compose -f infra/docker/compose.local.yml up --build
  1. Check backend health:
curl -i http://localhost:3007/api/v1/health
  1. Open the Apple workspace:
open apps/apple/Velody.xcworkspace

The local backend runs on http://localhost:3007.

Current Implemented Areas

  • upload ingest and transfer flow
  • Apple playback experience
  • iPhone library sync and offline playback resilience
  • account and device-linking foundation
  • billing and entitlement foundation work

Not Yet Exposed Public Areas

  • public login and signup APIs
  • public account authentication APIs
  • Paddle checkout
  • Paddle webhooks
  • public billing APIs