Add README
This commit is contained in:
98
README.md
Normal file
98
README.md
Normal file
@@ -0,0 +1,98 @@
|
||||
# Music Hub
|
||||
|
||||
Versionsverwaltung für Musikproduktionen. Kein Chaos mehr in Dropbox-Ordnern voller `final_v2_WIRKLICH_FINAL.wav`.
|
||||
|
||||
## Was ist das?
|
||||
|
||||
Music Hub ist eine kollaborative Plattform für Produzenten, Engineers und Labels. Tracks haben Versionen, Versionen haben Kommentare, und alle Beteiligten sehen was gerade der aktuelle Stand ist — ohne dass jemand eine WAV-Datei per WhatsApp schickt.
|
||||
|
||||
**Features:**
|
||||
- Projekte und Tracks mit vollständiger Versionshistorie
|
||||
- Wellenform-Ansicht direkt im Browser (WaveSurfer.js)
|
||||
- Zeitgestempelte Kommentare auf Versionen
|
||||
- Share-Links für externe Reviewer (kein Account nötig)
|
||||
- Magic-Link-Auth — kein Passwort-Reset-Chaos
|
||||
- S3-kompatibler File-Storage (Hetzner Object Storage)
|
||||
|
||||
## Stack
|
||||
|
||||
| Layer | Tech |
|
||||
|-------|------|
|
||||
| Frontend | SvelteKit + TypeScript |
|
||||
| Backend | Hono (Bun) |
|
||||
| Datenbank | PostgreSQL + Drizzle ORM |
|
||||
| Storage | S3-kompatibel (Hetzner / MinIO) |
|
||||
| Email | Resend |
|
||||
| Deploy | Coolify, Docker |
|
||||
|
||||
Monorepo mit Turborepo: `apps/web`, `apps/api`, `packages/db`, `packages/shared`.
|
||||
|
||||
## Setup (lokal)
|
||||
|
||||
**Voraussetzungen:** Bun, Docker
|
||||
|
||||
```bash
|
||||
# Dependencies
|
||||
bun install
|
||||
|
||||
# Dienste starten (Postgres + MinIO)
|
||||
docker compose up -d
|
||||
|
||||
# .env anlegen
|
||||
cp .env.example .env
|
||||
|
||||
# Dev-Server
|
||||
bun dev
|
||||
```
|
||||
|
||||
Web läuft auf `http://localhost:5173`, API auf `http://localhost:3000`.
|
||||
|
||||
### Umgebungsvariablen
|
||||
|
||||
Pflicht-Variablen in `.env`:
|
||||
|
||||
```env
|
||||
DATABASE_URL=postgresql://musichub:musichub@localhost:5433/musichub
|
||||
MAGIC_LINK_SECRET=<openssl rand -hex 32>
|
||||
APP_URL=http://localhost:5173
|
||||
```
|
||||
|
||||
Für E-Mail-Versand (optional, ohne läuft Magic Link in der Konsole):
|
||||
```env
|
||||
RESEND_API_KEY=re_...
|
||||
EMAIL_FROM=Music Hub <noreply@example.com>
|
||||
```
|
||||
|
||||
## Datenbankmigrationen
|
||||
|
||||
```bash
|
||||
# Schema ändern → Migration generieren
|
||||
bun db:generate
|
||||
|
||||
# Migration anwenden
|
||||
bun db:migrate
|
||||
```
|
||||
|
||||
## Deployment
|
||||
|
||||
Läuft auf [Coolify](https://coolify.mydrugismusic.com) via GitHub-Mirror (`robinchoice/music-hub`).
|
||||
|
||||
- **Web:** [hub.mydrugismusic.com](https://hub.mydrugismusic.com)
|
||||
- **API:** intern via `API_INTERNAL_URL`
|
||||
|
||||
Deploy wird per Webhook getriggert (siehe `reference_coolify.md` in den Projekt-Notizen).
|
||||
|
||||
## Projektstruktur
|
||||
|
||||
```
|
||||
music-hub/
|
||||
├── apps/
|
||||
│ ├── api/ # Hono API (Bun)
|
||||
│ └── web/ # SvelteKit Frontend
|
||||
├── packages/
|
||||
│ ├── db/ # Drizzle Schema + Migrationen
|
||||
│ └── shared/ # Zod-Schemas, gemeinsame Typen
|
||||
├── Dockerfile.api
|
||||
├── Dockerfile.web
|
||||
└── docker-compose.yml
|
||||
```
|
||||
Reference in New Issue
Block a user