django-adminlte2-pdq 0.2.1

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.

Django-AdminLTE2-PDQ

Django-AdminLTE2-PDQ is 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.

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.
• Easy sidebar menu creation.
• Automatic Django 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 & Font Awesome 5 integration.
• Highly configurable functionality, via project Django settings variables.

The full documentation can be found on Read The Docs.

Quickstart

1. Install the Django App via GitHub for now. Working on getting on Pypi soon.

   python -m pip install django-adminlte2-pdq
   

2. Add "adminlte2_pdq" to your INSTALLED_APPS setting like this:

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

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

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. 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'
   

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 and the rest of the full documentation on Read The Docs.