mrleo1nidandClaude Opus 5.5
1633b28c1a
ci / contract (сгенерированный код совпадает с openapi.yaml) (push) Successful in 47s
ci / api (push) Successful in 53s
ci / recommender (push) Successful in 37s
ci / ts (packages + web) (push) Successful in 38s
ci / mobile (Metro-бандл Android) (push) Successful in 52s
- docs/install-guide.md: step-by-step server setup (DNS, Docker, install.sh, .env, launch, checks), web and Android client setup, own reverse proxy variant, updates, backups and troubleshooting - deploy/compose.tls.yaml + Caddyfile: optional Caddy with automatic Let's Encrypt in front of nginx (enabled via COMPOSE_FILE in .env) - nginx: honour X-Forwarded-Proto/For from private networks - .env.example: DOMAIN, ACME_EMAIL, COMPOSE_FILE, bootstrap admin vars - install.sh: create caddy data dirs; release.yml: ship TLS files as assets - deployment.md, docs index and README link to the guide Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
70 lines
2.8 KiB
Markdown
70 lines
2.8 KiB
Markdown
# pipu-music
|
|
|
|
Self-hosted музыкальный сервис: веб и Android-приложение, библиотека на NFS,
|
|
умная бесконечная лента «Моя волна» с учётом вкуса, звучания треков и настроения.
|
|
|
|
- Идея продукта: [docs/IDEA.md](docs/IDEA.md)
|
|
- Документация для разработки: [docs/README.md](docs/README.md)
|
|
- План: [docs/roadmap.md](docs/roadmap.md)
|
|
- Установка сервера на свой домен: [docs/install-guide.md](docs/install-guide.md)
|
|
|
|
## Структура
|
|
|
|
| Путь | Что |
|
|
|---|---|
|
|
| `api/openapi.yaml` | Контракт публичного API — источник истины для сервера и клиентов |
|
|
| `services/api` | Go: публичный API (`cmd/api`) и агент хранилищ (`cmd/storage-agent`) |
|
|
| `services/recommender` | Python: рекомендации (`pipu-rec serve`) и аудиоанализ (`pipu-rec analyze`) |
|
|
| `apps/web` | Веб-клиент (React + Vite) |
|
|
| `apps/mobile` | Android-приложение (React Native + Expo) |
|
|
| `packages/*` | Общий TS-код: `api-client`, `core`, `i18n`, `design-tokens` |
|
|
| `deploy/` | Docker Compose, nginx, скрипты установки и обновления |
|
|
| `tests/fixtures/music` | Генератор тестовой библиотеки (нужен ffmpeg) |
|
|
| `.gitea/workflows` | CI (`ci.yml`) и релиз по тегу (`release.yml`) |
|
|
|
|
## Разработка
|
|
|
|
Нужны: Go 1.24+, Node 22 + pnpm 11, uv, Docker; для Android — JDK 17 и Android SDK.
|
|
|
|
```bash
|
|
pnpm install
|
|
docker compose -f deploy/compose.dev.yaml up -d
|
|
```
|
|
|
|
API (из `services/api`):
|
|
|
|
```bash
|
|
DATABASE_URL="postgres://pipu:pipu@localhost:5432/pipu?sslmode=disable" REDIS_URL="redis://localhost:6379/0" go run ./cmd/api
|
|
```
|
|
|
|
Веб на http://localhost:5173 (проксирует `/api` на `:8080`):
|
|
|
|
```bash
|
|
pnpm --filter @pipu/web dev
|
|
```
|
|
|
|
Проверки — те же, что в CI:
|
|
|
|
```bash
|
|
pnpm typecheck && pnpm test && pnpm i18n:check && pnpm test:scripts
|
|
```
|
|
|
|
```bash
|
|
cd services/api && go vet ./... && go test ./...
|
|
```
|
|
|
|
```bash
|
|
cd services/recommender && uv run ruff check . && uv run mypy pipu_rec && uv run pytest
|
|
```
|
|
|
|
После изменения `api/openapi.yaml` или `packages/design-tokens/tokens.json` перегенерируйте код и закоммитьте результат:
|
|
|
|
```bash
|
|
pnpm generate && (cd services/api && go generate ./...)
|
|
```
|
|
|
|
## Релиз
|
|
|
|
Тег `vX.Y.Z` (или `vX.Y.Z-rc.N`) запускает `.gitea/workflows/release.yml`: проверки → образы в Gitea Container Registry →
|
|
подписанный APK → Gitea Release. Нужные переменные и секреты перечислены в шапке workflow и в [docs/ci-cd.md](docs/ci-cd.md).
|