Initial commit: проект документации YARU

docs/README.md

@@ -0,0 +1,80 @@
+# Документация проекта YARU
+
+**Yet Another Russian Uncompleted...** — федеративная социальная сеть на базе ActivityPub
+
+---
+
+## 📁 Разделы документации
+
+| Раздел | Описание | Статус |
+|--------|----------|--------|
+| [Backend](backend/README.md) | FastAPI, PostgreSQL, ActivityPub, экспорт данных | ✅ Заполнен |
+| [Frontend](frontend/README.md) | Svelte, компоненты, редактор, real-time | ✅ Заполнен |
+| [Marketing](marketing/README.md) | Позиционирование, аудитория, конкуренты, брендинг | ✅ Заполнен |
+| [Design](design/README.md) | Логотип, цвета, типографика, компоненты | 📝 Требует утверждения |
+| [API](api/README.md) | REST + ActivityPub спецификации | ✅ Заполнен |
+| [Deployment](deployment/README.md) | Docker, CI/CD, мониторинг, бэкапы | ✅ Заполнен |
+
+---
+
+## 🎯 О проекте
+
+YARU — это попытка создать альтернативу Mastodon со следующими особенностями:
+
+- ✅ **Без ограничений на длину поста** — пишите статьи, а не твиты
+- ✅ **Экспорт данных** — ваш контент всегда принадлежит вам (Markdown + медиа)
+- ✅ **Fediverse совместимость** — полная совместимость с Mastodon
+- ✅ **Карма** — качественная оценка контента вместо лайков
+- ✅ **Сменяемая концепция** — название адаптируется под контекст
+
+### Стек технологий
+
+| Компонент | Технология |
+|-----------|------------|
+| Бэкенд | Python 3.11+ + FastAPI |
+| Фронтенд | Svelte 4+ + TypeScript |
+| База данных | PostgreSQL 15+ (основная + кэш + очереди) |
+| Протокол | ActivityPub (Fediverse) |
+| Редактор | Временное решение (Chronicle в разработке) |
+
+---
+
+## 📋 MVP функционал
+
+1. **Лента** — домашняя и публичная
+2. **Профили** — создание, редактирование, аватар
+3. **Посты** — создание, редактирование, удаление (без ограничения длины)
+4. **Подписки** — follow/unfollow, список подписчиков
+5. **Карма** — начисление/списание, защита от накрутки
+6. **Экспорт** — выгрузка всего контента в Markdown + медиа
+
+---
+
+## 🔍 Вопросы для обсуждения
+
+### Критичные для начала разработки
+
+1. **ActivityPub совместимость** — обсуждение полной совместимости с Mastodon (обратная связь?)
+2. **Дизайн** — кто делает макеты, есть ли предпочтения по цветам/стилю?
+3. **Хостинг** — где размещать (Timeweb, Selectel, Hetzner, свой сервер)?
+4. **Домен** — использовать yaru.nixg.ru или купить отдельный (yaru.ru, yaru.social)?
+5. **Редактор** — какой WYSIWYG выбрать для MVP (TipTap, Quill, Markdown textarea)?
+
+### Технические детали
+
+- Нужен ли SSR (SvelteKit) или достаточно SPA?
+- Как хранить медиа: локально, S3, или оба варианта?
+- Требуется ли модерация контента (админ-панель)?
+- Нужна ли программа раннего доступа?
+
+---
+
+## 📞 Контакты и ресурсы
+
+- **Репозиторий**: `yaru.nixg.ru`
+- **Редактор**: [chronicle.nixg.ru](https://chronicle.nixg.ru)
+- **Документация для разработчиков**: см. разделы выше
+
+---
+
+*Последнее обновление: 2026-03-01*