Документация Pipu Music
Pipu Music — self-hosted музыкальный сервис (веб + Android) с умной бесконечной лентой «Моя волна».
Карта документов
| Документ | О чём |
|---|---|
| IDEA.md | Продукт глазами пользователя |
| design.md | Дизайн-система: токены, шрифты, анимация, кнопка волны, каркас экранов |
| architecture.md | Общая архитектура, компоненты, потоки данных, структура репозитория |
| data-model.md | Схема БД PostgreSQL |
| api.md | REST API: соглашения, эндпоинты, ошибки |
| auth-and-roles.md | Аутентификация, токены, роли и права, первый запуск |
| library-and-storage.md | Хранилища (NFS), шаблоны путей, сканер, метаданные, поиск |
| uploads.md | Предложение треков модераторами: очередь, квота, дубли, одобрение, раскладка в хранилище |
| playback.md | Стриминг, транскодинг, состояние плеера, офлайн |
| genius.md | Genius: токен, поиск метаданных, парсинг текстов и проверочная команда |
| playlists.md | Личные плейлисты: API, веб и Android |
| social.md | Друзья, заявки, личные сообщения, уведомления и отправка музыки |
| recommendations.md | Рекомендательная система и «Моя волна» |
| web.md | Веб-клиент |
| desktop.md | Десктоп Windows / Linux / macOS (Tauri) |
| mobile.md | Android-приложение, офлайн, самообновление |
| i18n.md | Локализация (ru / en, расширяемость) |
| install-guide.md | Пошагово: установка сервера на домен с HTTPS, подключение веба и Android |
| admin-guide.md | Администратору: пользователи, хранилища, очередь, волна, обновления, диагностика |
| server-management.md | Управление обновлениями и config.local из админки, установка агента |
| deployment.md | Справочник по развёртыванию: сервисы, каталоги, переменные |
Стек в одном абзаце
Backend API — Go; рекомендации и аудиоанализ — Python; БД — PostgreSQL + pgvector; поиск — Meilisearch; кэш / очереди событий — Redis; раздача аудио — nginx (X-Accel-Redirect); веб — React + TypeScript + Vite; мобильное — React Native (Expo, Android); деплой — Docker Compose.