From c3fd112ffed457ed05a6fd1ed18d906bb6e40a1b Mon Sep 17 00:00:00 2001
From: protokey <protokey0@gmail.com>
Date: Thu, 24 Sep 2026 00:40:49 +0400
Subject: [PATCH] =?UTF-8?q?docs:=20=D0=B4=D0=BE=D0=BA=D1=83=D0=BC=D0=B5?=
 =?UTF-8?q?=D0=BD=D1=82=D0=B0=D1=86=D0=B8=D1=8F=20=D0=B2=D0=B5=D0=B7=D0=B4?=
 =?UTF-8?q?=D0=B5?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 Makefile                          |  3 +++
 README.md                         |  1 +
 docker-compose.yaml               |  5 ++++-
 src/App/README.md                 |  5 +++++
 src/App/models.py                 |  1 +
 src/MyPointVPN/README.md          |  3 +++
 src/MyPointVPN/settings/README.md | 12 ++++++++++++
 src/README.md                     |  8 ++++++++
 src/design/README.md              |  3 +++
 src/design/static/README.md       |  3 +++
 src/design/templates/README.md    |  3 +++
 11 files changed, 46 insertions(+), 1 deletion(-)
 create mode 100644 Makefile
 create mode 100644 src/App/README.md
 create mode 100644 src/MyPointVPN/README.md
 create mode 100644 src/MyPointVPN/settings/README.md
 create mode 100644 src/README.md
 create mode 100644 src/design/README.md
 create mode 100644 src/design/static/README.md
 create mode 100644 src/design/templates/README.md

diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..3cb5147
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,3 @@
+# TODO: добавить make команды для создания и применения миграций, создания супер пользователя и запуск тестового сервера
+dj_makemigrations:
+	cd src/ && ./manage.py makemigrations
diff --git a/README.md b/README.md
index fe0384f..f08c835 100644
--- a/README.md
+++ b/README.md
@@ -288,6 +288,7 @@ id	0/0Mb	On
 5. Установка 3x-ui
 6. Выпуск сертификата
 7. Настройка vless+tls+reality
+8. Настройка прокси
 
 ### Функционал бота
 
diff --git a/docker-compose.yaml b/docker-compose.yaml
index 53d6cac..a83e5b0 100644
--- a/docker-compose.yaml
+++ b/docker-compose.yaml
@@ -1,3 +1,6 @@
 services:
   xui:
-    image: ...
+    # TODO: настроить поднятие сервиса 3x-ui для тестирования api
+
+  telegram:
+    # TODO: настроить старт телеграм сервиса предоставляемый pyTelegramBotAPI
diff --git a/src/App/README.md b/src/App/README.md
new file mode 100644
index 0000000..fbaf76f
--- /dev/null
+++ b/src/App/README.md
@@ -0,0 +1,5 @@
+## App
+
+Django приложение связывающее все части сайта в одном месте. Никто не импортирует App, кроме MyPointVPN, а App может импортировать все.
+
+-[ ] Реализует кастомный менеджер модели и кастомную модель пользователя с отключенным email.
diff --git a/src/App/models.py b/src/App/models.py
index 6b20219..1f68ccb 100644
--- a/src/App/models.py
+++ b/src/App/models.py
@@ -1 +1,2 @@
 # Create your models here.
+# TODO: создать менеджер модель пользователя и кастомную модель пользователя в которой уберем поле email и позволим регистрироваться только по username и password
diff --git a/src/MyPointVPN/README.md b/src/MyPointVPN/README.md
new file mode 100644
index 0000000..e03955a
--- /dev/null
+++ b/src/MyPointVPN/README.md
@@ -0,0 +1,3 @@
+## MyPointVPN
+
+Файлы конфигурации Django.
diff --git a/src/MyPointVPN/settings/README.md b/src/MyPointVPN/settings/README.md
new file mode 100644
index 0000000..2212161
--- /dev/null
+++ b/src/MyPointVPN/settings/README.md
@@ -0,0 +1,12 @@
+## Настройки
+
+- `base.py` - базовые настройки Django - нельзя редактировать
+- `project.py` - настройки проекта - все параметры проекта, которые он заводит и определяет живут тут
+
+Допустимо создавать свои файлы настроек, и первой строкой следует импортировать `prokect.py`.
+
+```python
+from .project import *
+
+# Define your settings here
+```
diff --git a/src/README.md b/src/README.md
new file mode 100644
index 0000000..9285e7a
--- /dev/null
+++ b/src/README.md
@@ -0,0 +1,8 @@
+# MyPointVPN
+
+Это Django сайт.
+
+- `design` - фронт
+- `App` - главное приложение
+- `MyPointVPN` - настройки django
+- `manage.py` - точка входа
diff --git a/src/design/README.md b/src/design/README.md
new file mode 100644
index 0000000..081c4ee
--- /dev/null
+++ b/src/design/README.md
@@ -0,0 +1,3 @@
+## Design
+
+Файлы frontend.
diff --git a/src/design/static/README.md b/src/design/static/README.md
new file mode 100644
index 0000000..e6da0b3
--- /dev/null
+++ b/src/design/static/README.md
@@ -0,0 +1,3 @@
+## Static
+
+Исходники скриптов, картинок и стилей для фронта.
diff --git a/src/design/templates/README.md b/src/design/templates/README.md
new file mode 100644
index 0000000..c6becdf
--- /dev/null
+++ b/src/design/templates/README.md
@@ -0,0 +1,3 @@
+## Templates
+
+Файлы шаблонов html.