Документация проекта Saga¶

Saga - платформа пассивного дохода на основе DeFi протоколов. Концепция "банковского окна" - интерфейс между пользователем и финансовым оператором, обеспечивающий безопасность и удобство управления инвестициями.

💡 Философия проекта: Saga не хранит секреты, но обеспечивает безопасный и удобный интерфейс между клиентом и оператором капитала. Максимальная простота для пользователя, максимальная гибкость для оператора.

Выберите свою роль¶

👥 Пользователь¶

Вы используете Saga для инвестиций

📖 Документация для пользователей

Начало работы
Стейкинг гайд
FAQ

💼 Бизнес/PM¶

Вам нужен обзор, стратегия, roadmap

📊 Бизнес-документация

Whitepaper
Roadmap
Конкурентный анализ

👨‍💻 Разработчик¶

Вы разрабатываете или интегрируете

⚙️ Developer docs

API Reference
Архитектура
Guides

Integration-Only архитектура¶

Enterprise API интеграции

🔗 System Overview

Crypto2B API интеграция
Fordefi Enterprise Custody
Supabase Auth

Quick Start¶

Запуск системы (Cloud Native архитектура)¶

git clone <repo>
cd saga
make restart                # Умный перезапуск с пересборкой

Доступ к приложениям¶

User App: http://app.saga.local:8080
Admin App: http://admin.saga.local:8080
Backend API: http://localhost:8080/api

Первые шаги для разработчиков¶

🏗️ Архитектура - Понять систему
📋 Onboarding - Быстрый старт
🧪 Тестирование - make test

📖 Основные разделы¶

Архитектура ¶

Архитектурный обзор
🏗️ Системная архитектура Integration-Only MVP - Полная архитектура с диаграммами
ADR (Architecture Decision Records)
Системные диаграммы
Критические пути

🧩 Модули системы ¶

Backend модули (Auth, Storage, Notification)
Frontend модули (User App, Admin App)

Руководства ¶

API Reference ¶

Полный API Reference

Быстрый поиск по темам¶

Функциональность¶

Аутентификация: Email-first Auth
Депозиты/Выводы: Integration-Only paths

Технологии¶

Go Backend: Backend modules
Next.js Frontend: Frontend modules
Integration APIs: Crypto2B & Fordefi
PostgreSQL: Database guide
Docker/VPS: Deployment

Статус документации¶

Coverage по категориям:

✅ Architecture: 39 документов
✅ Developer Guides: 28 документов
✅ Modules: 7 документов
✅ Business Docs: Phase 2 Complete (6 core documents: whitepaper, economic model, external integrations, project overview, banking window concept, roadmap)
⚠️ API Reference: In Progress (102 endpoints, Phase 3)
📋 User Docs: Planned (Phase 5)

Анализ покрытия:

make analyze-documentation        # Запустить анализатор документации
make analyze-documentation-gaps   # Только gaps detection

Последнее обновление: 2025-11-17

🛠️ Основные команды¶

Разработка¶

make restart              # ⚡ Умный перезапуск
make status              # 📊 Статус системы
make analyze             # 🔍 Анализ архитектуры

Тестирование¶

make test                # 🚀 Foundation тесты (smoke+unit+core+e2e-smoke)
make test-all            # 💪 Полное тестирование (~3 мин, 30+ групп)
make smoke               # 🔥 Быстрые критичные тесты (~30сек)

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

make analyze-documentation          # Анализ покрытия документации
make docs-serve                    # Локальный сервер (если настроен)

🆘 Troubleshooting¶

Частые проблемы¶

Система не запускается: make restart
Тесты падают: make status → проверить сервисы
БД ошибки: make migration-up
Frontend ошибки: make generate-types

Диагностика¶

make status                           # Состояние всех сервисов
docker logs saga                      # Логи контейнера
PGPASSWORD=aisee psql -U aisee -h 127.0.0.1 -d saga  # Проверка БД

🤝 Участие в развитии документации¶

Документация - живой организм проекта. Чтобы улучшить документы:

Прочитайте Contributing Guide
Используйте шаблоны (см. meta/templates/ директорию)
Следуйте Style Guide

Нашли ошибку? Создайте GitHub issue с тегом documentation

Дополнительные ресурсы¶

Справочники¶

Compliance¶

Meta¶

📋 Метаданные¶

Версия: 2.6.268

Обновлено: 2025-10-21

Статус: Published