Modern template for Django Admin Interface coded on top of Corporate UI Dashboard, an open-source Bootstrap 5
design from Creative-Tim.
Actively supported by AppSeed via
Discord
.
- Django Corporate Dashboard -
Product
that uses the libraryFeatures
: Fully-configured,CI/CD
via Render
- UI Kit: Corporate Dashboard BS5 by
Creative-Tim
- Sections Covered:
Admin Section
, reserved forsuperusers
All pages
managed byDjango.contrib.AUTH
Registration
pageMisc pages
: colors, icons, typography, blank-page
- Modern Bootstrap 5 Design
Responsive Interface
Minimal Template
overridingEasy integration
Install the package via
PIP
$ pip install django-admin-corporate
// OR
$ pip install git+https://github.com/app-generator/django-admin-corporate.git
Add
admin_corporate
application to theINSTALLED_APPS
setting of your Django projectsettings.py
file (note it should be beforedjango.contrib.admin
):
INSTALLED_APPS = (
...
'admin_corporate.apps.AdminCorporateConfig',
'django.contrib.admin',
)
Add
LOGIN_REDIRECT_URL
andEMAIL_BACKEND
of your Django projectsettings.py
file:
LOGIN_REDIRECT_URL = '/'
# EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
Add
admin_corporate
urls in your Django Projecturls.py
file
from django.urls import path, include
urlpatterns = [
...
path('', include('admin_corporate.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/
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:
< LIBRARY_ROOT > # This exists in ENV: LIB/admin_corporate
|
|-- 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-fullscreen.html # Masterpage for Auth Pages
| |
| |-- pages/
| |-- index.html # Dashboard page
| |-- profile.html # Settings 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 your appStep 2
: configure the project to use this new template directory- Edit
settings.py
TEMPLATES section
- Edit
Step 3
: copy thefooter.html
from the original location (inside your ENV) and save it to theYOUR_APP/templates
DIR- Source PATH:
<YOUR_ENV>/LIB/admin_corporate/includes/footer.html
- Destination PATH:
YOUR_APP/templates/includes/footer.html
- Source PATH:
- Edit the footer (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.
The SCSS/CSS files used to style the Ui are saved in the static
directory.
In order to update the Ui colors (primary, secondary) this procedure needs to be followed.
$ yarn # Install modules
$ # Edit variables
$ vi admin_corporate/static/scss/corporate-ui-dashboard/_variables.scss
$ gulp # SCSS to CSS translation
The _variables.scss
content defines the primary
and secondary
colors:
$primary: #774dd3 !default; // EDIT for customization
$secondary: #64748b !default; // EDIT for customization
$info: #55a6f8 !default; // EDIT for customization
$success: #67c23a !default; // EDIT for customization
$warning: #f19937 !default; // EDIT for customization
$danger: #ea4e3d !default; // EDIT for customization
Django Admin Corporate - Modern Admin Interface provided by AppSeed