Quickstart

Install the Django package via pip.

python -m pip install django-adminlte2-pdq

Add “adminlte2_pdq” to your INSTALLED_APPS setting in <PROJECT_FOLDER>/settings.py like this:
```
INSTALLED_APPS = [
    'adminlte2_pdq',
    ...
]
```
Important

The adminlte2_pdq app should be listed before any Django apps so that template overriding works correctly.
Django-AdminLTE2-PDQ provides a middleware that is required for some of the available authentication and authorization policies from this package to function.

Add this middleware to your middleware list in <PROJECT_FOLDER>/settings.py.
```
MIDDLEWARE = [
    ...
    'adminlte2_pdq.middleware.AuthMiddleware',
]
```

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 <PROJECT_FOLDER>/urls.py.

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),
]

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. 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.
```
LOGIN_REDIRECT_URL = 'adminlte2_pdq:home'
```
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 following the Longstart.