59 lines
1.3 KiB
Markdown
59 lines
1.3 KiB
Markdown
# Velody
|
|
|
|
Velody is a private music ecosystem for personal use across `macOS`, `iPhone`, and a VPS backend.
|
|
|
|
This repository currently contains the execution foundation for Phase 1:
|
|
|
|
- `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 Development
|
|
|
|
1. Copy the example environment file:
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
```
|
|
|
|
2. Start Postgres and the API:
|
|
|
|
```bash
|
|
docker compose -f infra/docker/compose.local.yml up --build
|
|
```
|
|
|
|
3. Open the Apple workspace:
|
|
|
|
```bash
|
|
open apps/apple/Velody.xcworkspace
|
|
```
|
|
|
|
## Current Scope
|
|
|
|
This phase intentionally provides:
|
|
|
|
- backend contracts and scaffolding
|
|
- database schema and initial migration
|
|
- local filesystem storage readiness checks
|
|
- placeholder Apple apps and shared packages
|
|
|
|
This phase intentionally does not yet implement:
|
|
|
|
- folder watching
|
|
- upload chunk transfer
|
|
- background downloads
|
|
- audio playback
|
|
|
|
The local backend now defaults to `http://localhost:3007`.
|