Django Theme Material Kit

Modern Theme for Django that covers authentication pages (registration included) crafted on top of Material Kit, an open-source Bootstrap 5 design from Creative-Tim.

Actively supported by AppSeed via Email and Discord.

Links & Resources

• Django Material Kit - Product page
  • Features: Fully-configured, CI/CD via Render
• UI Kit: Material Kit (Bootstrap 5) by Creative-Tim
• Sections Covered:
  • All pages managed by Django.contrib.AUTH
  • Registration page
  • Misc pages: colors, icons, typography, blank-page

Why Django Theme Material Kit

• Modern Bootstrap 5 Design
• Minimal Template overriding
• Easy integration
• Fully compatible with Django.contrib.AUTH
• Registration page included

How to use it

Install the package via PIP

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

Add theme_material_kit application to the INSTALLED_APPS setting of your Django project settings.py:

INSTALLED_APPS = [
    "django.contrib.admin",
    "django.contrib.auth",
    "django.contrib.contenttypes",
    "django.contrib.sessions",
    "django.contrib.messages",
    "django.contrib.staticfiles",

    'theme_material_kit',          # <-- NEW 
]

Update project settings.py file to include (at the end of the file):

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

Add theme_material_kit urls in your Django Project urls.py file.

from django.urls import path, include       # <-- UPD with 'include' directive

urlpatterns = [
    ...
    path('', include('theme_material_kit.urls')),  #  <-- NEW
]

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

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/theme_material_kit
< UI_LIBRARY_ROOT >                      
   |
   |-- templates/                     # Root Templates Folder 
   |    |          
   |    |-- accounts/       
   |    |    |-- sign-in.html         # Sign IN Page
   |    |    |-- sign-up.html         # Sign UP Page
   |    |
   |    |-- includes/       
   |    |    |-- footer.html          # Footer component
   |    |    |-- navigation.html      # Navigation Bar
   |    |    |-- scripts.html         # Scripts Component
   |    |
   |    |-- layouts/       
   |    |    |-- base.html            # Masterpage
   |    |
   |    |-- pages/       
   |         |-- index.html           # Dashboard Page
   |         |-- author.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 index.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 index.html from the original location (inside your ENV) and save it to the YOUR_APP/templates DIR
  • Source PATH: <YOUR_ENV>/LIB/theme_material_kit/templates/pages/index.html
  • Destination PATH: YOUR_APP/templates/pages/index.html
• Edit the index.html (Destination PATH)

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

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

PRO Version

Material Kit 2 is a premium design crafted by the Creative-Tim agency on top of Bootstrap 5 Framework. Designed for those who like bold elements and beautiful websites, Material Kit 2 is made of hundreds of elements, designed blocks, and fully coded pages built with an impressive level of quality.

• Django Material Kit2 PRO - product page
  • Enhanced UI - more pages and components
  • Priority on support

---

Django Theme Material Kit - Modern Theme provided by AppSeed