docs: add README
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
2025-06-16 13:47:08 +03:00
parent 549f40ee6c
commit 7f1a2a8ab7
6 changed files with 33 additions and 2 deletions

6
.gitmodules vendored
View File

@@ -4,3 +4,9 @@
[submodule "ping-helper"] [submodule "ping-helper"]
path = ping-helper path = ping-helper
url = https://gitea.mrixs.me/minecraft-platform/ping-helper.git 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

23
README.md Normal file
View File

@@ -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/`: Вспомогательные скрипты (миграции, бэкапы).

Submodule backend updated: 5cd84d4f7b...0e2e02622d

1
frontend Submodule

Submodule frontend added at d7d61f9de3

1
launcher Submodule

Submodule launcher added at 888e9dfa9f