ci / contract (сгенерированный код совпадает с openapi.yaml) (push) Successful in 3m55s
ci / api (push) Successful in 51s
ci / mobile (Metro-бандл Android) (push) Canceled after 0s
release / images (services/api/Dockerfile, storage-agent, storage-agent) (push) Canceled after 0s
release / images (services/recommender/Dockerfile, recommender, ) (push) Canceled after 0s
ci / recommender (push) Successful in 1m11s
ci / ts (packages + web) (push) Canceled after 3s
release / verify (push) Successful in 1m16s
release / images (apps/web/Dockerfile, web, ) (push) Failing after 2m40s
release / android + release (push) Skipped
release / images (services/api/Dockerfile, api, api) (push) Canceled after 1s
- api/openapi.yaml: contract with /healthz, /readyz, /api/v1/server-info - services/api (Go): api with oapi-codegen strict server, goose migrations, readiness checks for Postgres/Redis; storage-agent stub with internal token - services/recommender (Python, uv): FastAPI health/readiness/internal status, `pipu-rec serve` and `pipu-rec analyze` entrypoints - packages: generated api-client, core (server URL + server check), i18n (ru/en + dictionary check), design-tokens (CSS vars + TS from tokens.json) - apps/web: Vite + React shell showing server status, language switch - apps/mobile: Expo (SDK 53) Android app with server connect screen - deploy: Dockerfiles, compose (prod + dev), nginx template, install/update scripts - .gitea/workflows: ci.yml and tag-based release.yml (images, signed APK, release) - scripts/version.mjs: version and Android versionCode from git tag - tests/fixtures/music/generate.sh: synthetic test library via ffmpeg - docs: versionCode formula, OpenAPI 3.0.3, dev instructions in README Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
69 lines
2.7 KiB
Markdown
69 lines
2.7 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)
|
|
|
|
## Структура
|
|
|
|
| Путь | Что |
|
|
|---|---|
|
|
| `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).
|