docs: add README

2025-06-16 13:47:08 +03:00
parent 549f40ee6c
commit 7f1a2a8ab7
6 changed files with 33 additions and 2 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,23 @@
+# Игровая Платформа Minecraft
+
+[![Build Status](https://drone.mrixs.me/api/badges/minecraft-platform/platform/status.svg)](https://drone.mrixs.me/minecraft-platform/platform)
+
+Этот репозиторий является центральной точкой для проекта "Платформа Minecraft". Он объединяет все компоненты системы с помощью Git-субмодулей и содержит основную конфигурацию для развертывания и CI/CD.
+
+## Архитектура
+
+Проект построен на микросервисной архитектуре с использованием Docker и Docker Compose. Автоматическая сборка и развертывание осуществляется с помощью Drone CI.
+
+### Компоненты (субмодули)
+
+*   `backend/`: Основной бэкенд-сервер на Go. Реализует Yggdrasil API, Web API и Admin API.
+*   `frontend/`: Веб-интерфейс на Vue.js для пользователей и администраторов.
+*   `ping-helper/`: Вспомогательный WebSocket-сервис на Go для измерения пинга.
+*   `launcher/`: Кастомный игровой лаунчер (форк HMCL).
+
+### Конфигурация
+
+*   `.drone.yml`: Пайплайн для Drone CI.
+*   `docker-compose.yml`: Описание сервисов для Docker.
+*   `Caddyfile`: Конфигурация веб-сервера Caddy.
+*   `scripts/`: Вспомогательные скрипты (миграции, бэкапы).