ДОКУМЕНТАЦИЯ

ВВЕДЕНИЕ · § 000

Документация FreshDonate

Self-host open-source платформа для приёма донатов на Minecraft-серверах. Без посредников, без комиссий сервиса, без вендор-лока. Эта документация объясняет каждый аспект проекта.

§ 001

Что такое FreshDonate

Платформа из четырёх независимых сервисов, которые вместе превращают сайт-витрину в полноценный донат-магазин

01

fresh-donate-backend

Fastify API, платежи, вебхуки, очередь доставки

Fastify 5 · PostgreSQL 17 · Redis 7

02

fresh-donate-panel

Админка для владельца сервера

Nuxt 4 · Nuxt UI 4 · Pinia

03

fresh-donate-shop

Публичная витрина для игроков

Nuxt 4 · SSR · TypeScript

04

fresh-donate-plugin

Плагин Minecraft, выдающий покупки в игре

Kotlin 2.0 · Paper/Spigot 1.13+

§ 002

Как это работает

Жизненный цикл одной покупки — от клика в магазине до выдачи предмета в игре

  1. 01 -

    Игрок открывает shop, выбирает товар, вводит свой ник и почту.

  2. 02 -

    shop просит backend создать платёж. Бекенд идёт в YooKassa/Heleket/... и возвращает ссылку на оплату.

  3. 03 -

    Игрок оплачивает. Платёжный шлюз присылает вебхук на backend. Покупка помечается как оплаченная и попадает в очередь доставки.

  4. 04 -

    При следующем входе игрока на сервер plugin спрашивает у бекенда очередь и выполняет нужные команды. Альтернатива — доставка через RCON без плагина.

  5. 05 -

    Владелец сервера видит платёж, клиента и статистику в panel.

§ 003

С чего начать

Самый короткий путь до работающего магазина

ШАГ 01

Установить на сервер

Развернуть backend, panel, shop и БД одной командой через Docker Compose.

Открыть

ШАГ 02 · СКОРО

Подключить платежи

Получить ключи у YooKassa или Heleket и вставить их в админ-панель.

ШАГ 03 · СКОРО

Поставить плагин

Закинуть JAR в plugins/ и указать адрес бекенда в конфиге.

※ Документация развивается вместе с проектом. Если чего-то не хватает — напиши в Telegram или открой issue в Github.

FreshDonate