Django AdminLTE
Open-source Django project crafted on top of AdminLTE, an open-source and iconic Bootstrap
design.
The product is designed to deliver the best possible user experience with highly customizable feature-rich pages.
π Django AdminLTE -Product page
π Django AdminLTE -LIVE Demo
β Django AdminLTE -Video Presentation
Features:
β Up-to-date Dependencies
β Theme: Django AdminLTEv3.2.0
β Authentication:Django.contrib.AUTH
, Registrationπ Deployment
CI/CD
flow viaRender
Start the app in Docker
π Step 1 - Download the code from the GH repository (usingGIT
)
$ git clone https://github.com/app-generator/django-adminlte.git
$ cd django-adminlte
π Step 2 - Start the APP inDocker
$ docker-compose up --build
Visit http://localhost:5085
in your browser. The app should be up & running.
Manual Build
π Download the code
$ git clone https://github.com/app-generator/django-adminlte.git
$ cd django-adminlte
π Install modules viaVENV
$ virtualenv env
$ source env/bin/activate
$ pip install -r requirements.txt
π 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/
.
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, 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_adminlte
< 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
| |-- calendar.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 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_adminlte/template/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.
Render
Deploy on- 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.
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
β Design
: Django Theme Material2 -PRO Version
β 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
Django AdminLTE - Open-Source Django starter provided by AppSeed