Начало работы
Руководство по быстрому старту для разработчиков
Начало работы
Добро пожаловать в проект Манитон! Это руководство поможет вам поднять локальное окружение и запустить первые тесты.
Предварительные требования
Для работы с проектом вам понадобятся:
- 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 install2. Запуск окружения (Hybrid Dev Mode)
Мы используем гибридный подход: инфраструктура (Kafka, DB, Besu) работает в Kubernetes, а микросервисы запускаются локально для удобства отладки.
# Развернуть инфраструктуру в k8s и запустить сервисы локально
bun devЭта команда:
- Проверяет наличие
kubectlи доступ к кластеру. - Разворачивает компоненты через
infra/k8s. - Настраивает port-forwarding для доступа к Kafka, Postgres, Besu и Keycloak.
- Запускает микросервисы через
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/— Утилиты для автоматизации.