Skip to content

Commit

Permalink
v1.0.7 - Update DOCS Links
Browse files Browse the repository at this point in the history
  • Loading branch information
@app-generator
app-generator committed Nov 7, 2024
1 parent 92682f4 commit 567932c
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 173 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# CHANGELOG

## [1.0.7] 2024-11-07
### Changes

- Update [Django Admin AdminLTE - Documentation](https://app-generator.dev/docs/products/django-libs/theme-adminlte.html) Link
- Update [Django Admin AdminLTE - Sample Product](https://app-generator.dev/product/adminlte/django/) Link
- Added [Getting Started with Django](https://app-generator.dev/docs/technologies/django/index.html) Link
- Added [AdminLTE](https://app-generator.dev/docs/templates/bootstrap/adminlte.html) design mention

## [1.0.6] 2024-09-16
### Changes

Expand Down
181 changes: 11 additions & 170 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,186 +1,27 @@
# [Django AdminLTE Theme](https://appseed.us/product/adminlte/django/)
# [Django AdminLTE](https://app-generator.dev/docs/products/django-libs/theme-adminlte.html)

Modern template for **Django Admin Interface** coded on top of **[AdminLTE](https://appseed.us/product/adminlte/django/)**, an iconic Bootstrap Dashboard template.
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.

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

<br>
<br />

**Links & Resources**
## **Features**

- [Django AdminLTE](https://appseed.us/product/adminlte/django/) - `Product` that uses the library
- `Features`: Fully-configured, `CI/CD` via Render
- UI Kit: `AdminLTE` by ColorLib **v3.2.0**
- Design: **[AdminLTE](https://app-generator.dev/docs/templates/bootstrap/adminlte.html)** (Bootstrap)
- **Sections Covered**:
- `Admin Section`, reserved for `superusers`
- `All pages` managed by `Django.contrib.AUTH`
- `Registration` page
- `Misc pages`: colors, icons, typography, blank-page

<br />

![AdminLTE - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/168842202-9b80a957-a375-4e6d-8247-2cc459267a86.png)

<br />

## Why `Django AdminLTE Theme`

- Modern [Bootstrap](https://www.admin-dashboards.com/bootstrap-5-templates/) Design
- `Responsive Interface`
- `Minimal Template` overriding
- `Easy integration`

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.

<br />

## How to use it

<br />

> **Install the package** via `PIP`
```bash
$ pip install django-admin-adminlte
// OR
$ pip install git+https://github.com/app-generator/django-admin-adminlte.git
```

<br />

> Add `admin_adminlte` application to the `INSTALLED_APPS` setting of your Django project `settings.py` file (note it should be before `django.contrib.admin`):
```python
INSTALLED_APPS = (
...
'admin_adminlte.apps.AdminAdminlteConfig',
'django.contrib.admin',
)
```

<br />

> Add `LOGIN_REDIRECT_URL` and `EMAIL_BACKEND` of your Django project `settings.py` file:
```python
LOGIN_REDIRECT_URL = '/'
# EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
```

<br />

> Add `admin_adminlte` urls in your Django Project `urls.py` file
```python
from django.urls import path, include

urlpatterns = [
...
path('', include('admin_adminlte.urls')),
]
```

<br />

> **Collect static** if you are in `production environment`:
```bash
$ python manage.py collectstatic
```

<br />

> **Start the app**
```bash
$ # Set up the database
$ python manage.py makemigrations
$ python manage.py migrate
$
$ # Create the superuser
$ python manage.py createsuperuser
$
$ # Start the application (development mode)
$ python manage.py runserver # default port 8000
```

Access the `admin` section in the browser: `http://127.0.0.1:8000/`

<br />

## How to Customize

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.
The theme used to style this starter provides the following files:

```bash
# This exists in ENV: LIB/admin_adminlte
< UI_LIBRARY_ROOT >
|
|-- templates/ # Root Templates Folder
| |
| |-- accounts/
| | |-- login.html # Sign IN Page
| | |-- register.html # Sign UP Page
| |
| |-- includes/
| | |-- footer.html # Footer component
| | |-- sidebar.html # Sidebar component
| | |-- navigation.html # Navigation Bar
| | |-- scripts.html # Scripts Component
| |
| |-- layouts/
| | |-- base.html # Masterpage
| | |-- base-auth.html # Masterpage for Auth Pages
| |
| |-- pages/
| |-- index.html # Dashboard Page
| |-- calendar.html # Profile Page
| |-- *.html # All other pages
|
|-- ************************************************************************
```

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.

For instance, if we want to customize the `footer.html` these are the steps:

- `Step 1`: create the `templates` DIRECTORY inside your app
- `Step 2`: configure the project to use this new template directory
- Edit `settings.py` TEMPLATES section
- `Step 3`: copy the `footer.html` from the original location (inside your ENV) and save it to the `YOUR_APP/templates` DIR
- Source PATH: `<YOUR_ENV>/LIB/admin_adminlte/templates/includes/footer.html`
- Destination PATH: `YOUR_APP/templates/includes/footer.html`
- Edit the `footer.html` (Destination PATH)

At this point, the default version of the `footer.html` shipped in the library is ignored by Django.

In a similar way, all other files and components can be customized easily.

<br />


## [PRO Version](https://appseed.us/product/material-dashboard2-pro/django/)

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.

> Features:
- `Up-to-date Dependencies`
- `Design`: `Django Theme Material` (PRO Version)
- `Sections` covered by the design:
- **Admin section** (reserved for superusers)
- **Authentication**: `Django.contrib.AUTH`, Registration
- **All Pages** available in for ordinary users
- `Docker`, `Deployment`:
- `CI/CD` flow via `Render`


<br />

![Material Dashboard 2 Pro](https://user-images.githubusercontent.com/51070104/211141418-6b7886eb-6fb3-433e-91c9-2895c086099a.png)
![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)

<br />

---
**[Django AdminLTE Theme](https://appseed.us/product/adminlte/django/)** - Modern Admin Interface provided by **[AppSeed](https://appseed.us/)**
**[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)**
6 changes: 3 additions & 3 deletions setup.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@

setup(
name='django-admin-adminlte',
version='1.0.6',
version='1.0.7',
zip_safe=False,
packages=find_packages(),
include_package_data=True,
description='Modern template for Django admin interface',
description='Modern template for Django Admin - AdminLTE Design',
long_description=README,
long_description_content_type="text/markdown",
url='https://appseed.us/product/adminlte/django/',
url='https://app-generator.dev/docs/products/django-libs/theme-adminlte.html',
author='AppSeed.us',
author_email='support@appseed.us',
license='MIT License',
Expand Down

0 comments on commit 567932c

Please sign in to comment.