Манитон Docs

Начало работы

Руководство по быстрому старту для разработчиков

Начало работы

Добро пожаловать в проект Манитон! Это руководство поможет вам поднять локальное окружение и запустить первые тесты.

Предварительные требования

Для работы с проектом вам понадобятся:

  • Kubernetes (Docker Desktop k8s, Minikube или Kind)
  • kubectl (CLI для управления кластером)
  • Bun (основной рантайм для скриптов и сервисов)
  • Go 1.22+ (для разработки Besu Connector)
  • Turbo (npm install -g turbo)
  • Buf CLI (для работы с Protobuf)

Быстрый старт

1. Клонирование и установка зависимостей

git clone https://github.com/maniton-monorepo.git
cd maniton-monorepo
bun install

2. Запуск окружения (Hybrid Dev Mode)

Мы используем гибридный подход: инфраструктура (Kafka, DB, Besu) работает в Kubernetes, а микросервисы запускаются локально для удобства отладки.

# Развернуть инфраструктуру в k8s и запустить сервисы локально
bun dev

Эта команда:

  1. Проверяет наличие kubectl и доступ к кластеру.
  2. Разворачивает компоненты через infra/k8s.
  3. Настраивает port-forwarding для доступа к Kafka, Postgres, Besu и Keycloak.
  4. Запускает микросервисы через turbo dev с пробросом нужных переменных окружения.

3. Проверка состояния

Вы можете проверить статус подов в Kubernetes:

bun dev status
# или напрямую
kubectl get pods -n maniton

Или запустить скрипт проверки здоровья:

bun health

Основные команды

КомандаОписание
bun devЗапуск dev-окружения.
bun testЗапуск всех тестов (Playwright + Unit).
bun lintПроверка кодстайла.
buf generateГенерация кода из Protobuf контрактов.

Структура репозитория

  • apps/ — Микросервисы и приложения.
  • packages/ — Общие пакеты (contracts, utils, ui).
  • docs/ — Техническая документация (этот сайт).
  • infra/ — Конфигурации K8s, Docker и мониторинга.
  • scripts/ — Утилиты для автоматизации.

Полезные ссылки

On this page