Django Admin Volt

Modern template for Django Admin Interface coded on top of Volt Dashboard (free version). Volt Dashboard is a free and open source Bootstrap 5 Admin Dashboard featuring over 100 components, 11 example pages and 3 plugins with Vanilla JS.

Originally coded by Iman Karimi, actively supported by AppSeed via Github (issues tracker) and Discord.

Links & Resources

Django Volt Dashboard - Open-source starter that uses the same UI Kit
Django Volt Dashboard - LIVE Demo
More Django Dashboards provided by AppSeed

Why Django Admin Volt?

Bootstrap 5 Design: Volt Dashboard (Free version) provided by Themesberg
New fresh look
Responsive mobile interface
Useful admin home page
Minimal template overriding
Easy integration

How to use it

Install the package via PIP

$ pip install django-admin-volt
// OR
$ pip install git+https://github.com/app-generator/django-admin-volt.git

Add admin_volt application to the INSTALLED_APPS setting of your Django project settings.py file (note it should be before django.contrib.admin):

    INSTALLED_APPS = (
        ...
        'admin_volt.apps.AdminVoltConfig',
        'django.contrib.admin',
    )

All programs you add in INSTALLED_APPS should look like this: APP_NAME.apps.APP_NAMEConfig.

In this feature, we considered that each App can have its own icon, so we ask users to use this feature according to the method. Also in apps.py of each program according to the example add the icon field in the corresponding class. You can go here to use more icons

    from django.apps import AppConfig

    class APP_NAMEConfig(AppConfig):
        name = 'APP_NAME'
        icon = 'ICON_CLASS'  # for example: icon = 'fa fa-users'

Make sure django.template.context_processors.request context processor is enabled in settings.py (Django 1.8+ way):

    TEMPLATES = [
        {
            'BACKEND': 'django.template.backends.django.DjangoTemplates',
            'DIRS': [],
            'APP_DIRS': True,
            'OPTIONS': {
                'context_processors': [
                    ...
                    'django.template.context_processors.request',
                    ...
                ],
            },
        },
    ]

⚠️ Warning!!

Before Django 1.8 you should specify context processors different way. Also use django.core.context_processors.request instead of django.template.context_processors.request.

    from django.conf import global_settings

    TEMPLATE_CONTEXT_PROCESSORS = global_settings.TEMPLATE_CONTEXT_PROCESSORS + (
        'django.core.context_processors.request',
    )

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/

Screenshots

Django Admin Volt - Provided by AppSeed App Generator

aijogja / django-admin-volt Goto Github PK