From e1a9d11af52f16ecdd3ce4436c5017f88003b568 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=D0=92=D0=B8=D0=BA=D1=82=D0=BE=D1=80?=
 <78488229+viktor138irk@users.noreply.github.com>
Date: Tue, 19 May 2026 05:52:35 +0900
Subject: [PATCH] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=BB=D0=B5?=
 =?UTF-8?q?=D0=BD=D0=B0=20=D0=B4=D0=BE=D0=BA=D1=83=D0=BC=D0=B5=D0=BD=D1=82?=
 =?UTF-8?q?=D0=B0=D1=86=D0=B8=D1=8F=20MVP=20v0.1.0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 80 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 80 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..37f3dc8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,80 @@
+# vkmgr — StackWorks VK Hub
+
+Универсальное VK Mini App для групп ВКонтакте: заявки, услуги, клиенты, статусы, Telegram-уведомления и базовая админка.
+
+## Назначение
+
+`vkmgr` — SaaS/Mini App для владельцев групп VK. Первая версия закрывает самую частую боль групп: заявки теряются в личке, комментариях и сообщениях. Приложение даёт группе единый мини-кабинет: услуги, форма заявки, статусы, админка и уведомления.
+
+## Что внутри
+
+- `frontend/` — VK Mini App на React + VKUI + VK Bridge.
+- `backend/` — Node.js API на Express + SQLite.
+- `docs/` — roadmap, API, схема базы.
+- `infra/` — docker-compose и nginx-заготовка.
+- `install.sh` — базовый установщик на VPS.
+
+## MVP v0.1.0
+
+- Инициализация пользователя через VK launch params.
+- Подключение группы.
+- Каталог услуг.
+- Создание заявки клиентом.
+- Админский список заявок.
+- Смена статусов заявки.
+- Telegram-уведомление о новой заявке.
+- Базовые роли: owner, manager, client.
+
+## Быстрый запуск backend
+
+```bash
+cd backend
+cp .env.example .env
+npm install
+npm run dev
+```
+
+API будет доступен на `http://localhost:8080`.
+
+## Быстрый запуск frontend
+
+```bash
+cd frontend
+cp .env.example .env
+npm install
+npm run dev
+```
+
+Frontend будет доступен на `http://localhost:5173`.
+
+## Установка из репозитория на VPS
+
+```bash
+git clone https://github.com/viktor138irk/vkmgr.git
+cd vkmgr
+sudo bash install.sh
+```
+
+Можно задать домены перед запуском:
+
+```bash
+sudo FRONTEND_DOMAIN=vk.example.com API_DOMAIN=api-vk.example.com bash install.sh
+```
+
+После установки HTTPS:
+
+```bash
+certbot --nginx -d vk.example.com -d api-vk.example.com
+```
+
+## Для VK Mini Apps
+
+1. Создать приложение в кабинете VK-разработчика.
+2. Указать URL frontend в настройках mini app.
+3. В `frontend/.env` указать `VITE_API_URL`.
+4. В `backend/.env` указать `VK_APP_SECRET` для проверки подписи launch params.
+5. Для продакшна поставить HTTPS.
+
+## Важно
+
+Это стартовый MVP-скелет, не финальный SaaS. Перед боевым запуском нужно добавить полноценную проверку прав администратора группы через VK API, оплату тарифов, rate-limit, аудит действий и нормальную PostgreSQL/MySQL базу.