django-hero-gen 1.2.0 → 1.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +108 -66
  2. package/package.json +1 -1
  3. package/src/commands.js +1 -1
package/README.md CHANGED
@@ -1,6 +1,13 @@
1
- # 🦸‍♂️ Django Hero Gen (v1.1.11)
1
+ # 🦸‍♂️ Django Hero Gen (v1.2.1)
2
2
 
3
- **Django Hero Gen** — это мощный CLI-инструмент для мгновенного развертывания фронтенда и базовой логики Django-приложений. Забудь о рутинном написании кода авторизации, создании моделей и копировании Bootstrap-шаблонов. Делай это одной командой.
3
+ **Django Hero Gen** — CLI-инструмент для быстрого развертывания Django-приложений:
4
+ HTML-шаблоны на Bootstrap 5, базовая бизнес-логика, модели, формы, маршруты и настройки — **одной командой**.
5
+
6
+ Инструмент создан, чтобы:
7
+
8
+ - ускорить старт Django-проекта;
9
+ - убрать рутину (auth, модели, forms, urls);
10
+ - быстро подготовить проект для экзамена или MVP.
4
11
 
5
12
  ---
6
13
 
@@ -8,118 +15,153 @@
8
15
 
9
16
  ### Установка
10
17
 
11
- Установите пакет глобально, чтобы использовать команду `dj-gen` в любом месте:
18
+ Глобальная установка (рекомендуется):
12
19
 
13
20
  ```bash
14
21
  npm install -g django-hero-gen
15
-
16
22
  ```
17
23
 
18
- Или используйте через `npx` без установки:
24
+ Или запуск без установки через `npx`:
19
25
 
20
26
  ```bash
21
27
  npx django-hero-gen <команда>
22
-
23
28
  ```
24
29
 
25
- ### Полная инициализация
30
+ ---
26
31
 
27
- Создает основной набор файлов для быстрого старта (шаблоны + вьюхи + админка):
32
+ ## 🛠 Доступные команды
28
33
 
29
- ```bash
30
- dj-gen init
34
+ ### 1. HTML-шаблоны (Bootstrap 5)
31
35
 
32
- ```
36
+ > Запускать **в папке `templates/`**
37
+
38
+ | Команда | Файл | Описание |
39
+ | -------------------------- | -------------------- | --------------------------------------------- |
40
+ | `dj-gen base` | `base.html` | Базовый шаблон: Navbar, Footer, `{% block %}` |
41
+ | `dj-gen home` | `home.html` | Главная страница с Carousel и описанием |
42
+ | `dj-gen course_page` | `create_course.html` | Страница создания курса / заявки |
43
+ | `dj-gen my_course` | `my_course.html` | Список курсов / заявок с модальными окнами |
44
+ | `dj-gen login_page` | `login.html` | Страница входа |
45
+ | `dj-gen registration_page` | `registration.html` | Страница регистрации |
33
46
 
34
47
  ---
35
48
 
36
- ## 🛠 Доступные команды
49
+ ### 2. Django-логика (Python)
50
+
51
+ > Запускать **в папке приложения**
37
52
 
38
- ### 1. Шаблоны HTML (Bootstrap 5)
53
+ #### 📌 Views и Admin
39
54
 
40
- Команды для создания фронтенд-части. Запускать в папке `templates`.
55
+ - `dj-gen auth_view`
56
+ ➜ `views.py`
57
+ Авторизация, регистрация, cookies, login / logout
41
58
 
42
- | Команда | Файл | Описание |
43
- | -------------------------- | -------------------- | ----------------------------------------------- |
44
- | `dj-gen base` | `base.html` | Каркас: Navbar, Footer, блоки контента. |
45
- | `dj-gen home` | `home.html` | Главная: Слайдер (Carousel) и описание сервиса. |
46
- | `dj-gen course_page` | `create_course.html` | Страница с формой создания объектов. |
47
- | `dj-gen my_course` | `my_course.html` | Список карточек с модальными окнами. |
48
- | `dj-gen login_page` | `login.html` | Готовая страница входа. |
49
- | `dj-gen registration_page` | `registration.html` | Страница регистрации пользователей. |
59
+ - `dj-gen orders_view`
60
+ ➜ `order_views.py`
61
+ CRUD-логика курсов / заявок
50
62
 
51
- ### 2. Логика Python (Django)
63
+ - `dj-gen admin`
64
+ ➜ `admin.py`
65
+ Регистрация моделей в админке
66
+
67
+ ---
52
68
 
53
- Команды для генерации серверной части. Запускать в папке приложения.
69
+ #### 📌 Модели
54
70
 
55
- **Вьюхи и Админка:**
71
+ - `dj-gen modelUser`
72
+ ➜ `models.py`
73
+ Кастомный пользователь (`AbstractUser`)
56
74
 
57
- - `dj-gen auth_view` — Создает `views.py` (Авторизация, Регистрация, Cookies).
58
- - `dj-gen orders_view` — Создает `order_views.py` (Бизнес-логика заказов/курсов).
59
- - `dj-gen admin` — Стандартный `admin.py` для регистрации моделей.
75
+ - `dj-gen modelOrders`
76
+ ➜ `models.py`
77
+ Модель курсов / заявок
60
78
 
61
- **Модели и Формы:**
79
+ ---
62
80
 
63
- - `dj-gen modelsUser` — `models.py` с кастомным пользователем (AbstractUser).
64
- - `dj-gen modelsOrders` — `models.py` с моделью заявок/курсов.
65
- - `dj-gen userForm` — `forms.py` для регистрации и профиля.
66
- - `dj-gen orderForm` — `forms.py` для создания заявок.
81
+ #### 📌 Формы
67
82
 
68
- **Настройки и Маршруты:**
83
+ - `dj-gen userForm`
84
+ ➜ `forms.py`
85
+ Форма регистрации и профиля пользователя
69
86
 
70
- - `dj-gen settings` — Готовый блок настроек для `settings.py`.
71
- - `dj-gen authUrls` — `urls.py` для логики аккаунтов.
72
- - `dj-gen ordersUrls` — `urls.py` для логики заказов.
87
+ - `dj-gen orderForm`
88
+ ➜ `forms.py`
89
+ Форма создания заявки / курса
73
90
 
74
91
  ---
75
92
 
76
- ## 📁 Структура после развертывания
77
-
78
- При использовании `dj-gen init` в папке вашего приложения:
79
-
80
- ```text
81
- your_app/
82
- ├─ templates/
83
- │ ├─ base.html # Базовый шаблон
84
- │ ├─ home.html # Главная страница
85
- │ ├─ login.html # Вход
86
- │ ├─ registration.html # Регистрация
87
- │ ├─ create_course.html # Форма создания
88
- │ └─ my_course.html # Список объектов
89
- ├─ views.py # Логика Auth
90
- ├─ order_views.py # Логика Orders
91
- ├─ models.py # Модели
92
- ├─ forms.py # Формы
93
- ├─ urls.py # Маршруты
94
- └─ admin.py # Админка
93
+ #### 📌 URLs
95
94
 
96
- ```
95
+ - `dj-gen authUrls`
96
+ ➜ `urls.py`
97
+ Маршруты аутентификации
98
+
99
+ - `dj-gen ordersUrls`
100
+ ➜ `urls.py`
101
+ Маршруты курсов / заявок
97
102
 
98
103
  ---
99
104
 
100
- ## ⚙️ Важные настройки
105
+ #### 📌 Настройки
101
106
 
102
- Для работы сгенерированного кода убедитесь, что в вашем окружении установлены:
107
+ - `dj-gen settings`
108
+ ➜ Фрагмент для `settings.py`
109
+ Настройки templates, auth и сторонних библиотек
103
110
 
104
- 1. **Python зависимости:**
111
+ ---
112
+
113
+ ## ⚡ Полная генерация проекта
114
+
115
+ - `dj-gen init`
116
+
117
+ 📦 **Разворачивает ВСЁ сразу**:
118
+
119
+ - HTML-шаблоны
120
+ - Views
121
+ - Models
122
+ - Forms
123
+ - URLs
124
+ - Admin
125
+ - Settings
126
+
127
+ Идеально для быстрого старта или экзамена.
128
+
129
+ ---
130
+
131
+ ## ⚙️ Важные настройки
132
+
133
+ ### Установите зависимости:
105
134
 
106
135
  ```bash
107
136
  pip install django-bootstrap5 django-phonenumber-field
137
+ ```
108
138
 
139
+ ### В `settings.py`:
140
+
141
+ ```python
142
+ INSTALLED_APPS = [
143
+ ...
144
+ 'bootstrap5',
145
+ 'phonenumber_field',
146
+ ]
147
+
148
+ AUTH_USER_MODEL = 'your_app.CustomUser'
109
149
  ```
110
150
 
111
- 2. **В settings.py:**
151
+ Проверь:
112
152
 
113
- - Добавьте `'bootstrap5'` и `'phonenumber_field'` в `INSTALLED_APPS`.
114
- - Укажите `AUTH_USER_MODEL = 'имя_вашего_приложения.CustomUser'`.
115
- - Проверьте пути в `TEMPLATES` и `STATICFILES_DIRS`.
153
+ - `TEMPLATES`
154
+ - `STATICFILES_DIRS`
116
155
 
117
156
  ---
118
157
 
119
158
  ## 📜 Лицензия
120
159
 
121
- Лицензия **MIT**. Автор: **asappaholik**.
160
+ **MIT License**
161
+ Автор: **https://t.me/asapaholik**
162
+
163
+ ---
122
164
 
123
- **Удачной разработки и успешных экзаменов!**
165
+ 🔥 _Создавай Django-проекты быстрее. Без рутины. Без боли._
124
166
 
125
167
  ---
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "django-hero-gen",
3
- "version": "1.2.0",
3
+ "version": "1.2.1",
4
4
  "description": "Генератор шаблонов для Django",
5
5
  "main": "index.js",
6
6
  "bin": {
package/src/commands.js CHANGED
@@ -48,7 +48,7 @@ module.exports = {
48
48
  makeCreatePage: () => saveFile("create_course.html", createCourseTpl()),
49
49
  makeListPage: () => saveFile("my_course.html", myCourseTpl()),
50
50
  makeAuth: () => saveFile("views.py", authViewsTpl()),
51
- makeOrders: () => saveFile("order_views.py", orderViewsTpl()),
51
+ makeOrders: () => saveFile("views.py", orderViewsTpl()),
52
52
  makeModelOrders: () => saveFile("models.py", modelOrdersTpl()),
53
53
  makeModelUser: () => saveFile("models.py", modelUserTpl()),
54
54
  makeSettings: () => saveFile("settings.py", coreSettingsTpl()),