django-hero-gen 1.1.0 → 1.1.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.
- package/README.md +119 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
# 🦸♂️ Django Hero Gen
|
|
2
|
+
|
|
3
|
+
**Django Hero Gen** — это мощный CLI-инструмент для мгновенного развертывания фронтенда и базовой логики Django-приложений. Больше не нужно вручную копировать Bootstrap-шаблоны, настраивать Navbar или переписывать стандартные View для авторизации. Сделайте это одной командой и сэкономьте часы рутины.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 🚀 Быстрый старт
|
|
8
|
+
|
|
9
|
+
### Установка
|
|
10
|
+
|
|
11
|
+
Установите пакет глобально, чтобы команда `dj-gen` была доступна в любом месте:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install -g django-hero-gen
|
|
15
|
+
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Или используйте без установки через `npx`:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npx django-hero-gen <команда>
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### Полная инициализация проекта
|
|
26
|
+
|
|
27
|
+
Самый быстрый способ наполнить новое Django-приложение контентом. Создает все необходимые файлы одним махом:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
dj-gen init
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
> **Что будет создано:** `base.html`, `home.html`, `create_course.html`, `my_course.html`, `views.py`, `order_views.py`, `admin.py`.
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## 🛠 Доступные команды
|
|
39
|
+
|
|
40
|
+
### 1. Генерация шаблонов (HTML + Bootstrap 5)
|
|
41
|
+
|
|
42
|
+
Все шаблоны поддерживают наследование и адаптированы под мобильные устройства.
|
|
43
|
+
|
|
44
|
+
| Команда | Файл | Описание |
|
|
45
|
+
| ------------- | -------------------- | ----------------------------------------------------------------------------------------------- |
|
|
46
|
+
| `dj-gen base` | `base.html` | **Фундамент:** Navbar с логикой Auth, Footer, системные уведомления и подключенный Bootstrap 5. |
|
|
47
|
+
| `dj-gen home` | `home.html` | **Главная:** Слайдер (Carousel) с поддержкой static и информационный блок. |
|
|
48
|
+
| `dj-gen form` | `create_course.html` | **Формы:** Готовая разметка для рендеринга Django-форм через Bootstrap. |
|
|
49
|
+
| `dj-gen list` | `my_course.html` | **Личный кабинет:** Список карточек с индикаторами статуса и встроенными модальными окнами. |
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
### 2. Генерация логики (Python)
|
|
54
|
+
|
|
55
|
+
Готовые обработчики для типовых задач Django.
|
|
56
|
+
|
|
57
|
+
- **`dj-gen auth`** — Создает `views.py`. Включает:
|
|
58
|
+
- `registration_view` (с использованием CustomUserCreationForm).
|
|
59
|
+
- `login_view` и `logout_view`.
|
|
60
|
+
- `accept_cookies` (обработка согласия пользователя через Cookies).
|
|
61
|
+
|
|
62
|
+
- **`dj-gen orders`** — Создает `order_views.py`. Чистый файл для вашей бизнес-логики заказов или курсов.
|
|
63
|
+
- **`dj-gen admin`** — Создает `admin.py`. Базовый импорт и место для регистрации ваших моделей.
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
## 📁 Структура создаваемых файлов
|
|
68
|
+
|
|
69
|
+
После выполнения команды `dj-gen init` структура вашего приложения примет следующий вид:
|
|
70
|
+
|
|
71
|
+
```text
|
|
72
|
+
your_app/
|
|
73
|
+
├─ templates/
|
|
74
|
+
│ ├─ base.html # Базовый скелет сайта
|
|
75
|
+
│ ├─ home.html # Главная страница (extends base.html)
|
|
76
|
+
│ ├─ create_course.html # Страница создания (extends base.html)
|
|
77
|
+
│ └─ my_course.html # Список объектов (extends base.html)
|
|
78
|
+
├─ views.py # Логика пользователей и аутентификации
|
|
79
|
+
├─ order_views.py # Логика обработки бизнес-задач
|
|
80
|
+
└─ admin.py # Регистрация моделей в панели управления
|
|
81
|
+
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## ⚙️ Важные настройки после генерации
|
|
87
|
+
|
|
88
|
+
Для корректной работы созданных файлов выполните следующие шаги:
|
|
89
|
+
|
|
90
|
+
1. **Настройка путей:** Убедитесь, что в `settings.py` в секции `TEMPLATES` указана папка с вашими шаблонами.
|
|
91
|
+
2. **Зависимости:** Установите библиотеку для работы с формами:
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
pip install django-bootstrap5
|
|
95
|
+
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
И добавьте `'django_bootstrap5'` в `INSTALLED_APPS`. 3. **Маршрутизация:** Подключите созданные функции в вашем `urls.py`:
|
|
99
|
+
|
|
100
|
+
```python
|
|
101
|
+
from . import views, order_views
|
|
102
|
+
|
|
103
|
+
urlpatterns = [
|
|
104
|
+
path('', views.home_view, name='home'),
|
|
105
|
+
path('login/', views.login_view, name='login'),
|
|
106
|
+
# и так далее...
|
|
107
|
+
]
|
|
108
|
+
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
## 📜 Лицензия
|
|
114
|
+
|
|
115
|
+
Распространяется под лицензией **MIT**. Свободно для использования в коммерческих и личных проектах.
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
**Удачной разработки!**
|