Django Material PRO
Premium Django Starter coded on top of Material Bootstrap 4 design (Premium Version).
Premium Django Dashboard generated by AppSeed
on top of a modern design.
Material Dashboard is a premium Bootstrap 4
Admin Dashboard featuring over 100 components, and 11 example pages.
- 🛒 Django Material PRO -
Product page
(contains payment links) - 👉 Django Material PRO -
LIVE Demo
✅ Features
Up-to-date Dependencies
- UI Theme: Django Theme Material
- 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 viaRender
✅ 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
✅ Manual Build
👉 Download the code
$ git clone https://github.com/app-generator/django-material-dashboard-pro.git
$ cd django-material-dashboard-pro
Export
GITHUB_TOKEN
in the environment. The value is provided by AppSeed during purchase.
This is required because the project has a private REPO dependency: github.com/app-generator/priv-django-admin-material-pro
$ export GITHUB_TOKEN='TOKEN_HERE' # for Linux, Mac
$ set GITHUB_TOKEN='TOKEN_HERE' # Windows CMD
$ $env:GITHUB_TOKEN = 'TOKEN_HERE' # Windows powerShell
👉 Install modules via
VENV
.
$ virtualenv env
$ source env/bin/activate
$ pip install -r requirements.txt
👉 Edit the
.env
using the template.env.sample
.
# True for development, False for production
DEBUG=True
👉 Set Up Database
$ python manage.py makemigrations
$ python manage.py migrate
👉 Create the Superuser
$ python manage.py createsuperuser
👉 Start the app
$ python manage.py runserver
At this point, the app runs at http://127.0.0.1:8000/
.
✅ 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 manage.py createsuperuser
Once the superuser
is successfully created, we can access the admin
section:
http://localhost:8000/admin/
✅ Codebase structure
The project is coded using a simple and intuitive structure presented below:
< PROJECT ROOT >
|
|-- core/
| |-- settings.py # Project Configuration
| |-- urls.py # Project Routing
|
|-- home/
| |-- views.py # APP Views
| |-- urls.py # APP Routing
| |-- models.py # APP Models
| |-- tests.py # Tests
| |-- templates/ # Theme Customisation
| |-- includes #
| |-- custom-footer.py # Custom Footer
|
|
|-- requirements.txt # Project Dependencies
|
|-- env.sample # ENV Configuration (default values)
|-- manage.py # 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 is saved in ENV: LIB/admin_material_pro
< 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 # Index Page (presentation)
| |-- settings.html # Settings Page
| |-- dashboard.html # Dashboard 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 thetemplates
DIRECTORY inside thehome
app - ✅
Step 2
: configure the project to use this new template directorycore/settings.py
TEMPLATES section
- ✅
Step 3
: copy thefooter.html
from the original location (inside your ENV) and save it to thehome/templates
DIR- Source PATH:
<YOUR_ENV>/LIB/admin_material_pro/includes/footer.html
- Destination PATH:
<PROJECT_ROOT>home/templates/includes/footer.html
- Source PATH:
To speed up all these steps, the codebase is already configured (
Steps 1, and 2
) and acustom footer
can be found at this location:
home/templates/includes/custom_footer.html
By default, this file is unused because the theme
expects footer.html
(without the custom_
prefix).
In order to use it, simply rename it to footer.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
- Go to https://dashboard.render.com/blueprints this link.
- Click
New Blueprint Instance
button. - Connect your
repo
which you want to deploy. - Fill the
Service Group Name
and click onUpdate Existing Resources
button. - After that your deployment will start automatically.
At this point, the product should be LIVE.
✅ Resources
- 👉 Access AppSeed for more starters and support
- 👉 Get in touch for Custom Development Services