Nimbus Docs

Appearance

Nimbus Documentation ​

Это входная страница VitePress для документации Nimbus.

Основной индекс и оглавление находятся в файле index.md.

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

Главная навигация по документации проекта Nimbus — облачной платформы для автоматизации управления ЖКХ.

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

Техническая архитектура системы, компоненты и решения.

ДокументОписание
Инфологическая модель NimbusСущности домена (Organization, House, Room, PersonalAccount, Charge, LedgerEntry, AccountBalance, PenaltyRate) и их связи
Модули и их ответственностьРоли nimbus_auth, nimbus_core, nimbus_billing и их взаимодействие на уровне сценариев
Блочная структура системыФизическая архитектура: фронтенд, API‑шлюз, Go‑микросервисы, PostgreSQL, Redis, S3‑хранилище
Ядро биллинга: лицевые счета и начисленияЛицевые счета, связи сущностей, Golden Test, принципы Ledger (двойная запись)
Ставки и расчёт пеней (ПП 354, ЦБ РФ)Справочник ставок ЦБ, автозагрузка, расчёт пеней по правилам ЖКХ

Бизнес-логика ​

Описание правил расчётов, нормативов и доменной логики.

ДокументОписание
ПП 354: полный текст и ссылкиКаркас вокруг полного текста постановления 354 и ссылки на профильные разборы
ПП 354: общедомовые счётчикиАнализ использования показаний общедомовых приборов учёта и формул из приложений ПП 354
Архитектура долга и пенейМодель хранения долга, логика расчёта пеней и миграции задолженности в Nimbus

Руководства (Guides) ​

Онбординг, задачи, версионирование и статусы реализации.

ДокументОписание
ОнбордингСуть проекта, стек, жёсткие архитектурные правила, структура репозитория
Задачи для JuniorБезопасные задачи без изменения ядра расчётов (ПП 354, Ledger)
ВерсионированиеГлобальная и сервисные версии, команды, релизы
Статус меню и функционалаРеализованные пункты меню и экраны
Еженедельный отчёт по коммитамШаблон/отчёт по коммитам за неделю
Dev quick start (microservices)Быстрый старт разработки с локальными микросервисами и Docker‑сервисами БД/Redis
Docker prod setup на UbuntuЧек‑лист подготовки Ubuntu 24.04 LTS к прод‑деплою Nimbus в Docker
SMTP через Яндекс.ПочтуНастройка SMTP‑отправки писем через Яндекс.Почту для домена проекта
Startup guide микросервисовЗапуск микросервисов Nimbus локально и в Docker, порядок миграции данных
Migration guide к микросервисамПлан миграции с монолита на микросервисы Nimbus, статус реализации

Промпты (Cursor / AI) ​

Эталонные промпты для генерации кода и UI в Cursor и других AI-инструментах.

ДокументОписание
Шаблон CRUD (React + MUI)Промпт для создания типовой CRUD-страницы в админке

Бизнес и стейкхолдеры ​

Материалы для инвесторов, партнёров и описания продукта.

ДокументОписание
Продуктовая визияПозиционирование Nimbus, облачный биллинг ЖКХ
Executive SummaryКраткая презентация для инвесторов и партнёров
Стратегический план развитияДетальный план на 3 года, MVP, финансы, риски
Стратегические рекомендацииПрактические рекомендации и план на 90 дней
FAQ для инвесторовОтветы на типичные вопросы инвесторов
Обзор документовОписание созданных стратегических документов
Навигация по стратегическим документамКак использовать стратегические документы
Вопросы для партнёраВопросы и темы для обсуждения с партнёрами
Дорожная карта на 3 месяцаMVP, интеграции, отчётность, этапы разработки
Nimbus Billing: стратегия выхода на IPOБизнес‑питч для инвесторов, SaaS‑модель, технологический ров (Ledger, ПП 354, аудит‑готовая архитектура)

Связанные ресурсы ​