Skip to main content

Django Material Kit

Open-source Django Starter coded on top Material Kit BS5 Design (Free Version).

Open-source Django project crafted on top of Material Kit, an open-source design from Creative-Tim. The product is designed to deliver the best possible user experience with highly customizable feature-rich pages.

v1.0.7 - release date 2023-02-08

✅ Features

  • Up-to-date Dependencies
  • UI Theme: Material Kit BS5 designed by Creative-Tim
    • can be used in any Django project (new or legacy)
  • Authentication: Django.contrib.AUTH, Registration
  • Deployment
    • CI/CD flow via Render

Material Kit - Starter generated by AppSeed.

✅ Environment

To use the starter, Python3 should be installed properly in the workstation. If you are not sure if Python is installed, please open a terminal and type python --version. Here is the full list with dependencies and tools required to build the app:

  • Python3 - the programming language used to code the app
  • GIT - used to clone the source code from the Github repository
  • Basic development tools (g++ compiler, python development libraries ..etc) used by Python to compile the app dependencies in your environment.
  • (Optional) Docker - a popular virtualization software

✅ Start in Docker

👉 Step 1 - Download the code from the GH repository (using GIT)

$ git clone
$ cd django-material-kit

👉 Step 2 - Start the APP in Docker

$ docker-compose up --build

Visit http://localhost:5085 in your browser. The app should be up & running.

✅ Manual Build

Download the code

$ git clone
$ cd django-material-kit

👉 Set Up for Unix, MacOS

Install modules via VENV

$ virtualenv env
$ source env/bin/activate
$ pip3 install -r requirements.txt

Set Up Database

$ python makemigrations
$ python migrate

Start the app

$ python runserver

At this point, the app runs at

👉 Set Up for Windows

Install modules via VENV (windows)

$ virtualenv env
$ .\env\Scripts\activate
$ pip3 install -r requirements.txt

Set Up Database

$ python makemigrations
$ python migrate

Start the app

$ python runserver

At this point, the app runs at

✅ Manage App Users

By default, the starter is not provided with users. To access the private pages and the admin section (reserved for superusers) follow up the next sections.

👉 Create Superusers

To access the admin section, Django requires superuser privilegies. Let's create a new superuser and access the admin section of the project:

$ python createsuperuser

Once the superuser is successfully created, we can access the admin section:


✅ Codebase structure

The project is coded using a simple and intuitive structure presented below:

|-- core/
| |-- # Project Configuration
| |-- # Project Routing
|-- home/
| |-- # APP Views
| |-- # APP Routing
| |-- # APP Models
| |-- # Tests
| |-- templates/ # Theme Customisation
| |-- pages #
| |-- custom-index.html # Custom Index
|-- requirements.txt # Project Dependencies
|-- env.sample # ENV Configuration (default values)
|-- # Start the app - Django default start script
|-- ************************************************************************

✅ How to Customize

When a template file is loaded in the controller, 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
|-- 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 the home app
  • Step 2: configure the project to use this new template directory
    • core/ TEMPLATES section
  • Step 3: copy the index.html from the original location (inside your ENV) and save it to the home/templates DIR
    • Source PATH: <YOUR_ENV>/LIB/theme_material_kit/pages/index.html
    • Destination PATH: <PROJECT_ROOT>home/templates/pages/index.html

To speed up all these steps, the codebase is already configured (Steps 1, and 2) and a custom index can be found at this location:


By default, this file is unused because the theme expects index.html (without the custom- prefix).

In order to use it, simply rename it to index.html. Like this, the default version shipped in the library is ignored by Django.

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

✅ Deploy on Render

  • Create a Blueprint instance
  • Click New Blueprint Instance button.
  • Connect your repo which you want to deploy.
  • Fill the Service Group Name and click on Update Existing Resources button.
  • After that your deployment will start automatically.

At this point, the product should be LIVE.

✅ Resources