https://github.com/djbarnes/django-adminlte2-pdq
A Django app that takes all of the work out of making a beautiful and functional web application pretty darn quickly (PDQ) using the AdminLTE2 theme.
https://github.com/djbarnes/django-adminlte2-pdq
adminlte2 django fast rapid-development
Last synced: 9 months ago
JSON representation
A Django app that takes all of the work out of making a beautiful and functional web application pretty darn quickly (PDQ) using the AdminLTE2 theme.
- Host: GitHub
- URL: https://github.com/djbarnes/django-adminlte2-pdq
- Owner: DJBarnes
- License: mit
- Created: 2021-03-06T00:02:05.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-07-19T23:58:50.000Z (9 months ago)
- Last Synced: 2025-07-20T01:56:46.079Z (9 months ago)
- Topics: adminlte2, django, fast, rapid-development
- Language: Python
- Homepage:
- Size: 11.4 MB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Django-AdminLTE2-PDQ
[](https://img.shields.io/pypi/v/django-adminlte2-pdq?color=blue)
[](https://img.shields.io/badge/python-%3E%3D3.7-brightgreen)
[](https://img.shields.io/badge/django-%3E%3D3.2-brightgreen)
[](https://github.com/psf/black)
[](https://github.com/DJBarnes/django-adminlte2-pdq/actions/workflows/test.yaml)
[](https://coveralls.io/github/DJBarnes/django-adminlte2-pdq?branch=main)
[](https://django-adminlte2-pdq.readthedocs.io/en/latest/?badge=latest)
[](https://img.shields.io/github/license/DJBarnes/django-adminlte2-pdq)
[](https://pypi.python.org/pypi/django-adminlte2-pdq)
**Django-AdminLTE2-PDQ** is a [Django](https://www.djangoproject.com/) app
that takes all of the work out of making a beautiful and functional web
application pretty darn quickly (PDQ) using the
[AdminLTE2](https://adminlte.io/themes/AdminLTE/index2.html)
theme.
Additionally, the app provides decorators, mixins, template filters, and
template tags to aid in the rapid development of a site.
Features include:
* Styled with [AdminLTE2](https://adminlte.io/themes/AdminLTE/index2.html).
* Easy sidebar menu creation.
* Automatic
[Django Admin](https://docs.djangoproject.com/en/dev/ref/contrib/admin/)
styling that matches AdminLTE2.
* Automatic inclusion of Admin links in the sidebar.
* Automatic menu link hiding based on user permissions to views.
* Template filters to aid in manual styling.
* Template tags for form rendering that matches AdminLTE2.
* Automatic form error and message styling.
* [Font Awesome 4](https://fontawesome.com/v4/icons/)
& [Font Awesome 5](https://fontawesome.com/v5/search) integration.
* Highly configurable functionality, via project
[Django settings variables](https://docs.djangoproject.com/en/dev/topics/settings/).
The full documentation can be found on [Read The Docs](https://django-adminlte2-pdq.readthedocs.io/en/latest/).
## Quickstart
1. Install the Django App via GitHub for now. Working on getting on Pypi soon.
```shell
python -m pip install django-adminlte2-pdq
```
2. Add "adminlte2_pdq" to your INSTALLED_APPS setting like this:
```python
INSTALLED_APPS = [
'adminlte2_pdq',
...
]
```
---
:information_source: **NOTE**
The **adminlte2_pdq** app should be listed before any Django apps so
that template overriding works correctly.
---
3. Django-AdminLTE2-PDQ provides a middleware that is required for some of the
available authentication and authorization scenarios from this package to
function.
Add this middleware to your middleware list in ``/settings.py``.
```python
MIDDLEWARE = [
...
'adminlte2_pdq.middleware.AuthMiddleware',
]
```
4. Django-AdminLTE2-PDQ provides routes and templates for a default home page,
some sample pages, and Django's account pages. You should add these default
routes to your root URLconf in ``/urls.py``
```python
from django.contrib import admin
from django.urls import include
urlpatterns = [
# Adminlte2 default routes for demo purposes
path('', include('adminlte2_pdq.urls')),
# Django Account Routes - Styled in AdminLTE2
path('accounts/', include('django.contrib.auth.urls')),
# Admin - Styled in Django but hosted in AdminLTE2 layout
path('admin/', admin.site.urls),
]
```
5. Ensure that successful logins redirect to a valid endpoint.
Django-AdminLTE2-PDQ does not include a route or templates for
`/accounts/profile` which is the default
[Django Login redirect.](https://docs.djangoproject.com/en/dev/ref/settings/#login-redirect-url)
Adding the above entry to your `settings.py` file
will allow successful logins to redirect to the default provided home page
included in step 4.
```python
LOGIN_REDIRECT_URL = 'adminlte2_pdq:home'
```
6. The package should now have the required bare minimum setup complete.
You should be able to run the server and see the default pages located at:
``http://localhost:8000``
For a more detailed setup, consider reading the
[Longstart](https://django-adminlte2-pdq.readthedocs.io/en/latest/longstart.html)
and the rest of the full documentation on
[Read The Docs](https://django-adminlte2-pdq.readthedocs.io/en/latest/).