pipu-music/docs/README.md

Документация Pipu Music

Pipu Music — self-hosted музыкальный сервис (веб + Android) с умной бесконечной лентой «Моя волна».

Карта документов

Документ	О чём
IDEA.md	Исходная идея продукта глазами пользователя (вход для дизайна)
design.md	Дизайн-система (токены, шрифты, анимация), кнопка волны, решения по вариантам прототипа, ссылки на макеты
architecture.md	Общая архитектура, компоненты, потоки данных, структура репозитория
decisions.md	ADR — принятые архитектурные решения и их обоснование
data-model.md	Схема БД PostgreSQL
api.md	REST API: соглашения, эндпоинты, ошибки
auth-and-roles.md	Аутентификация, токены, роли и права, первый запуск
library-and-storage.md	Хранилища (NFS), шаблоны путей, сканер, метаданные, поиск
uploads.md	Предложение треков модераторами: очередь, квота, дубли, одобрение, раскладка в хранилище
playback.md	Стриминг, транскодинг, состояние плеера, офлайн
recommendations.md	Рекомендательная система и «Моя волна»
web.md	Веб-клиент
mobile.md	Android-приложение, офлайн, самообновление
i18n.md	Локализация (ru / en, расширяемость)
testing.md	Стратегия тестирования
ci-cd.md	Gitea Actions: проверки и релиз по тегу
install-guide.md	Пошагово: установка сервера на домен с HTTPS, подключение веба и Android
admin-guide.md	Администратору: пользователи, хранилища, очередь, волна, обновления, диагностика
deployment.md	Справочник по развёртыванию: сервисы, каталоги, переменные
conventions.md	Соглашения по коду, git, версиям
roadmap.md	Этапы разработки и критерии готовности

Стек в одном абзаце

Backend API — Go; рекомендации и аудиоанализ — Python; БД — PostgreSQL + pgvector; поиск — Meilisearch; кэш / очереди событий — Redis; раздача аудио — nginx (X-Accel-Redirect); веб — React + TypeScript + Vite; мобильное — React Native (Expo, Android); монорепо — pnpm + Turborepo; CI/CD — Gitea Actions; деплой — Docker Compose.