Skip to content

Commit 567932c

Browse files
app-generatorapp-generator
committed
v1.0.7 - Update DOCS Links
1 parent 92682f4 commit 567932c

3 files changed

Lines changed: 22 additions & 173 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# CHANGELOG
22

3+
## [1.0.7] 2024-11-07
4+
### Changes
5+
6+
- Update [Django Admin AdminLTE - Documentation](https://app-generator.dev/docs/products/django-libs/theme-adminlte.html) Link
7+
- Update [Django Admin AdminLTE - Sample Product](https://app-generator.dev/product/adminlte/django/) Link
8+
- Added [Getting Started with Django](https://app-generator.dev/docs/technologies/django/index.html) Link
9+
- Added [AdminLTE](https://app-generator.dev/docs/templates/bootstrap/adminlte.html) design mention
10+
311
## [1.0.6] 2024-09-16
412
### Changes
513

‎README.md‎

Lines changed: 11 additions & 170 deletions
Original file line numberDiff line numberDiff line change
@@ -1,186 +1,27 @@
1-
# [Django AdminLTE Theme](https://appseed.us/product/adminlte/django/)
1+
# [Django AdminLTE](https://app-generator.dev/docs/products/django-libs/theme-adminlte.html)
22

3-
Modern template for **Django Admin Interface** coded on top of **[AdminLTE](https://appseed.us/product/adminlte/django/)**, an iconic Bootstrap Dashboard template.
3+
Modern template for **[Django Admin](https://app-generator.dev/docs/products/django-libs/theme-adminlte.html)**, Auth Pages (registration included) crafted on top of **AdminLTE**, an open-source **Bootstrap** design.
44

5-
> Actively supported by [AppSeed](https://appseed.us/) via `Email` and `Discord`.
5+
- [Django Admin AdminLTE](https://app-generator.dev/docs/products/django-libs/theme-adminlte.html) - Documentation & Support Links
6+
- [Django AdminLTE](https://app-generator.dev/product/adminlte/django/) - The product that uses the library
7+
- [Getting Started with Django](https://app-generator.dev/docs/technologies/django/index.html) - Learn how to code **Django** Projects
68

7-
<br>
9+
<br />
810

9-
**Links & Resources**
11+
## **Features**
1012

11-
- [Django AdminLTE](https://appseed.us/product/adminlte/django/) - `Product` that uses the library
12-
- `Features`: Fully-configured, `CI/CD` via Render
13-
- UI Kit: `AdminLTE` by ColorLib **v3.2.0**
13+
- Design: **[AdminLTE](https://app-generator.dev/docs/templates/bootstrap/adminlte.html)** (Bootstrap)
1414
- **Sections Covered**:
1515
- `Admin Section`, reserved for `superusers`
1616
- `All pages` managed by `Django.contrib.AUTH`
1717
- `Registration` page
1818
- `Misc pages`: colors, icons, typography, blank-page
19-
20-
<br />
21-
22-
![AdminLTE - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/168842202-9b80a957-a375-4e6d-8247-2cc459267a86.png)
23-
24-
<br />
25-
26-
## Why `Django AdminLTE Theme`
27-
28-
- Modern [Bootstrap](https://www.admin-dashboards.com/bootstrap-5-templates/) Design
29-
- `Responsive Interface`
30-
- `Minimal Template` overriding
31-
- `Easy integration`
32-
33-
For newcomers, [AdminLTE](https://appseed.us/product/adminlte/) is a fully responsive administration template. Based on Bootstrap framework and also the JS/jQuery plugin. Highly customizable and easy to use. Fits many screen resolutions from small mobile devices to large desktops.
34-
35-
<br />
36-
37-
## How to use it
38-
39-
<br />
40-
41-
> **Install the package** via `PIP`
42-
43-
```bash
44-
$ pip install django-admin-adminlte
45-
// OR
46-
$ pip install git+https://github.com/app-generator/django-admin-adminlte.git
47-
```
48-
49-
<br />
50-
51-
> Add `admin_adminlte` application to the `INSTALLED_APPS` setting of your Django project `settings.py` file (note it should be before `django.contrib.admin`):
52-
53-
```python
54-
INSTALLED_APPS = (
55-
...
56-
'admin_adminlte.apps.AdminAdminlteConfig',
57-
'django.contrib.admin',
58-
)
59-
```
60-
61-
<br />
62-
63-
> Add `LOGIN_REDIRECT_URL` and `EMAIL_BACKEND` of your Django project `settings.py` file:
64-
65-
```python
66-
LOGIN_REDIRECT_URL = '/'
67-
# EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
68-
EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
69-
```
70-
71-
<br />
72-
73-
> Add `admin_adminlte` urls in your Django Project `urls.py` file
74-
75-
```python
76-
from django.urls import path, include
77-
78-
urlpatterns = [
79-
...
80-
path('', include('admin_adminlte.urls')),
81-
]
82-
```
83-
84-
<br />
85-
86-
> **Collect static** if you are in `production environment`:
87-
88-
```bash
89-
$ python manage.py collectstatic
90-
```
91-
92-
<br />
93-
94-
> **Start the app**
95-
96-
```bash
97-
$ # Set up the database
98-
$ python manage.py makemigrations
99-
$ python manage.py migrate
100-
$
101-
$ # Create the superuser
102-
$ python manage.py createsuperuser
103-
$
104-
$ # Start the application (development mode)
105-
$ python manage.py runserver # default port 8000
106-
```
107-
108-
Access the `admin` section in the browser: `http://127.0.0.1:8000/`
109-
110-
<br />
111-
112-
## How to Customize
113-
114-
When a template file is loaded, `Django` scans all template directories starting from the ones defined by the user, and returns the first match or an error in case the template is not found.
115-
The theme used to style this starter provides the following files:
116-
117-
```bash
118-
# This exists in ENV: LIB/admin_adminlte
119-
< UI_LIBRARY_ROOT >
120-
|
121-
|-- templates/ # Root Templates Folder
122-
| |
123-
| |-- accounts/
124-
| | |-- login.html # Sign IN Page
125-
| | |-- register.html # Sign UP Page
126-
| |
127-
| |-- includes/
128-
| | |-- footer.html # Footer component
129-
| | |-- sidebar.html # Sidebar component
130-
| | |-- navigation.html # Navigation Bar
131-
| | |-- scripts.html # Scripts Component
132-
| |
133-
| |-- layouts/
134-
| | |-- base.html # Masterpage
135-
| | |-- base-auth.html # Masterpage for Auth Pages
136-
| |
137-
| |-- pages/
138-
| |-- index.html # Dashboard Page
139-
| |-- calendar.html # Profile Page
140-
| |-- *.html # All other pages
141-
|
142-
|-- ************************************************************************
143-
```
144-
145-
When the project requires customization, we need to copy the original file that needs an update (from the virtual environment) and place it in the template folder using the same path.
146-
147-
For instance, if we want to customize the `footer.html` these are the steps:
148-
149-
- `Step 1`: create the `templates` DIRECTORY inside your app
150-
- `Step 2`: configure the project to use this new template directory
151-
- Edit `settings.py` TEMPLATES section
152-
- `Step 3`: copy the `footer.html` from the original location (inside your ENV) and save it to the `YOUR_APP/templates` DIR
153-
- Source PATH: `<YOUR_ENV>/LIB/admin_adminlte/templates/includes/footer.html`
154-
- Destination PATH: `YOUR_APP/templates/includes/footer.html`
155-
- Edit the `footer.html` (Destination PATH)
156-
157-
At this point, the default version of the `footer.html` shipped in the library is ignored by Django.
158-
159-
In a similar way, all other files and components can be customized easily.
160-
161-
<br />
162-
163-
164-
## [PRO Version](https://appseed.us/product/material-dashboard2-pro/django/)
165-
166-
This design is a pixel-perfect [Bootstrap 5](https://www.admin-dashboards.com/bootstrap-5-templates/) Dashboard with a fresh, new design inspired by Google's Material Design. `Material Dashboard 2 PRO` is built with over 300 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.
167-
168-
> Features:
169-
170-
- `Up-to-date Dependencies`
171-
- `Design`: `Django Theme Material` (PRO Version)
172-
- `Sections` covered by the design:
173-
- **Admin section** (reserved for superusers)
174-
- **Authentication**: `Django.contrib.AUTH`, Registration
175-
- **All Pages** available in for ordinary users
176-
- `Docker`, `Deployment`:
177-
- `CI/CD` flow via `Render`
178-
19+
17920
<br />
18021

181-
![Material Dashboard 2 Pro](https://user-images.githubusercontent.com/51070104/211141418-6b7886eb-6fb3-433e-91c9-2895c086099a.png)
22+
![Django AdminLTE - Modern template for Django Admin Section crafted on top of a modern Bootstrap, Open-Source Design.](https://user-images.githubusercontent.com/51070104/168842202-9b80a957-a375-4e6d-8247-2cc459267a86.png)
18223

18324
<br />
18425

18526
---
186-
**[Django AdminLTE Theme](https://appseed.us/product/adminlte/django/)** - Modern Admin Interface provided by **[AppSeed](https://appseed.us/)**
27+
**[Django AdminLTE](https://app-generator.dev/docs/products/django-libs/theme-adminlte.html)** - Modern Django Admin Interface provided by **[App-Generator](https://app-generator.dev)**

‎setup.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@
88

99
setup(
1010
name='django-admin-adminlte',
11-
version='1.0.6',
11+
version='1.0.7',
1212
zip_safe=False,
1313
packages=find_packages(),
1414
include_package_data=True,
15-
description='Modern template for Django admin interface',
15+
description='Modern template for Django Admin - AdminLTE Design',
1616
long_description=README,
1717
long_description_content_type="text/markdown",
18-
url='https://appseed.us/product/adminlte/django/',
18+
url='https://app-generator.dev/docs/products/django-libs/theme-adminlte.html',
1919
author='AppSeed.us',
2020
author_email='support@appseed.us',
2121
license='MIT License',

0 commit comments

Comments
 (0)