From c40bd412f9f184a36d4be2bf9b20a3b5ceb0a768 Mon Sep 17 00:00:00 2001
From: Sergey Elpashev <elpashevs@bk.ru>
Date: Fri, 13 Jun 2025 15:26:38 +0300
Subject: [PATCH] feat: new README.md

---
 README.md | 96 ++++++++++++++++++++++++++++++++++++++++++-------------
 1 file changed, 73 insertions(+), 23 deletions(-)

diff --git a/README.md b/README.md
index e215bc4..37f47e7 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,86 @@
-This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+# Telegram MiniApp для удобного информирования о прокси-подписке
 
-## Getting Started
+## Для инициализации
 
-First, run the development server:
-
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
+Сначала ставим пакеты:
+```
+bun i
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+Потом ставим prisma приколы:
+```
+bunx prisma generate
+```
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+Потом копируем .env.example в .env:
+```
+cp .env.example .env
+```
 
-This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
+Заполняем его данными всякими (где про базу данных, нужно, чтобы URL соответствовал остальным параметрам), где XUI пишем авторизацию для 3X-UI.
 
-## Learn More
+---
 
-To learn more about Next.js, take a look at the following resources:
+## Для разработки
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+Для разработки поднимаем базу данных и редиску:
+```
+docker-compose up -d db redis
+```
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+Заносим в базу данных таблицы:
+```
+bunx prisma db push
+```
 
-## Deploy on Vercel
+Можно запускать приложение, оно будет на http://localhost:3000:
+```
+bun run dev
+```
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+### Изменение БД
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
+Если нужно изменить schema.prisma, то нужно будет провести миграцию:
+```
+bunx prisma migrate dev --name *имя*
+```
+
+Для удобного взаимодействия с БД можно запустить prisma studio:
+```
+bunx prisma studio
+```
+
+### Для проверки в ТГ
+
+В BotFather указываем у бота MiniApp url - `https://127.0.0.1:3000` и запускаем сервер:
+```
+bun run dev:https
+```
+
+---
+
+## Для сборки и production запуска
+```
+docker compose up -d --build
+```
+
+### Если были изменения в БД:
+```
+docker compose exec app bunx prisma db push
+```
+
+---
+
+## Подключение к БД сторонними клиентами
+
+Подключиться к серверу:
+```
+ssh -L PORT1:localhost:PORT2 server
+```
+
+Где PORT1 - локальный порт, а PORT2 - порт БД на сервере. Подключаться нужно локально к PORT1.
+
+То есть, можно указать в .env `DATABASE_URL=postgresql://user:password@localhost:PORT1/dbname` и открыть prisma studio:
+```
+bunx prisma studio
+```