django-admin-material-dashboard 1.0.11

Modern template for Django admin interface

Django Admin Material

Modern Django Dashboard that covers Admin Section, all authentication pages (registration included) crafted on top of Material Dashboard, an open-source Bootstrap 5 design from Creative-Tim.

Actively supported by AppSeed via Email and Discord.

Links & Resources

• Django Admin Material - Product page
  • Features: Fully-configured, CI/CD via Render
• UI Kit: Material Dashboard BS5 v3.0.5 by Creative-Tim
• Sections Covered:
  • Admin Section, reserved for superusers
  • All pages managed by Django.contrib.AUTH
  • Registration page
  • Misc pages: colors, icons, typography, blank-page

Why Django Admin Material

• Modern Bootstrap 5 Design
• Responsive Interface
• Minimal Template overriding
• Easy integration

How to use it

Install the package via PIP

$ pip install django-admin-material-dashboard
// OR
$ pip install git+https://github.com/app-generator/django-admin-material-dashboard.git

Add admin_material application to the INSTALLED_APPS setting of your Django project settings.py file (note it should be before django.contrib.admin):

    INSTALLED_APPS = (
        ...
        'admin_material.apps.AdminMaterialDashboardConfig',
        'django.contrib.admin',
    )

Add LOGIN_REDIRECT_URL and EMAIL_BACKEND of your Django project settings.py file:

    LOGIN_REDIRECT_URL = '/'
    # EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
    EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'

Add admin_material urls in your Django Project urls.py file

    from django.urls import path, include

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

Collect static if you are in production environment:

$ python manage.py collectstatic

Start the app

$ # 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/

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:

# This exists in ENV: LIB/admin_material
< 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
   |         |-- profile.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_material/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.

CSS Styling

The UI can be customized via the SCSS file. This setup was tested using:

• Node v16.15.0
• Yarn 1.22.18
• Gulp CLI version: 2.3.0, Local version: 4.0.2

$ cd admin_material/static
$ yarn                                       # Install Modules 
$ vi scss/material-dashboard/_variables.scss # Edit primary, secondary colors
$ gulp                                       # Regenerate CSS files   

NOTE, once the CSS files are successfully regenerated, force a hard refresh in the browser (Shift + F5 in Chrome).

The relevant lines in _variables.scss are highlighted below:

// _variables.scss, LINES 56 -> 63
$primary:       #e91e63 !default;   // EDIT & Recompile SCSS
$secondary:     #7b809a !default;   // EDIT & Recompile SCSS
$info:          #1A73E8 !default;   // EDIT & Recompile SCSS
$success:       #4CAF50 !default;   // EDIT & Recompile SCSS
$warning:       #fb8c00 !default;   // EDIT & Recompile SCSS
$danger:        #F44335 !default;   // EDIT & Recompile SCSS
$light:         $gray-200 !default; // EDIT & Recompile SCSS
$dark:          $h-color !default;  // EDIT & Recompile SCSS

PRO Version

This design is a pixel-perfect Bootstrap 5 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
• UI Theme: Material2 PRO
  • can be used in any Django project (new or legacy)
• 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

---

Django Admin Material - Modern Admin Interface provided by AppSeed