From 7f1a2a8ab75e54f4fcd555d10aedb3b76d046fe3 Mon Sep 17 00:00:00 2001 From: Vladimir Zagainov Date: Mon, 16 Jun 2025 13:47:08 +0300 Subject: [PATCH] docs: add README --- .gitmodules | 6 ++++++ README.md | 23 +++++++++++++++++++++++ backend | 2 +- frontend | 1 + launcher | 1 + ping-helper | 2 +- 6 files changed, 33 insertions(+), 2 deletions(-) create mode 100644 README.md create mode 160000 frontend create mode 160000 launcher diff --git a/.gitmodules b/.gitmodules index d30936b..0eb7d5f 100644 --- a/.gitmodules +++ b/.gitmodules @@ -4,3 +4,9 @@ [submodule "ping-helper"] path = ping-helper url = https://gitea.mrixs.me/minecraft-platform/ping-helper.git +[submodule "frontend"] + path = frontend + url = https://gitea.mrixs.me/minecraft-platform/frontend.git +[submodule "launcher"] + path = launcher + url = https://gitea.mrixs.me/minecraft-platform/launcher.git diff --git a/README.md b/README.md new file mode 100644 index 0000000..3068c79 --- /dev/null +++ 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/`: Вспомогательные скрипты (миграции, бэкапы). diff --git a/backend b/backend index 5cd84d4..0e2e026 160000 --- a/backend +++ b/backend @@ -1 +1 @@ -Subproject commit 5cd84d4f7b82ddbf2fa8f2da7098edb09b1ae12b +Subproject commit 0e2e02622d158e518e178d38284f5a19613b8b1b diff --git a/frontend b/frontend new file mode 160000 index 0000000..d7d61f9 --- /dev/null +++ b/frontend @@ -0,0 +1 @@ +Subproject commit d7d61f9de33773a87b9e3f73d47a2ff49d00a0c5 diff --git a/launcher b/launcher new file mode 160000 index 0000000..888e9df --- /dev/null +++ b/launcher @@ -0,0 +1 @@ +Subproject commit 888e9dfa9f6ce4f614f9e084dc41fb64a35d7f40 diff --git a/ping-helper b/ping-helper index d8bd807..3f1e494 160000 --- a/ping-helper +++ b/ping-helper @@ -1 +1 @@ -Subproject commit d8bd80793974e0dd24c500fb65fbb75dc77f0763 +Subproject commit 3f1e4942ddc9d089c147f91f58d2d659c894661d