/django-admin-soft-dashboard

Django Admin Soft - Free template for Django Admin UI | AppSeed

Primary LanguageSCSSMIT LicenseMIT

Django Admin Soft

Modern Django Dashboard Admin Interface coded on top of Soft UI Dashboard, an open-source Bootstrap 5 design from Creative-Tim.

Actively supported by AppSeed via Email and Discord.


Features:

  • Django Soft Dashboard - Product that uses the library
    • Features: Fully-configured, CI/CD via Render
  • UI Kit: Soft Dashboard BS5 by Creative-Tim
  • Sections Covered:
    • Admin Section, reserved for superusers
    • All pages managed by Django.contrib.AUTH
    • Registration page
    • Misc pages: colors, icons, typography, blank-page

Django Admin Soft - Template project for Django provided by AppSeed.


Why Django Admin Soft

  • Modern Bootstrap 5 Design
  • Responsive Interface
  • Minimal Template overriding
  • Easy integration

How to use it


Install the package via PIP

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

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

    INSTALLED_APPS = (
        ...
        'admin_soft.apps.AdminSoftDashboardConfig',
        'django.contrib.admin',
    )

Add LOGIN_REDIRECT_URL and EMAIL_BACKEND of your Django project settings.py file:

    LOGIN_REDIRECT_URL = '/'
    # EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
    EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'

Add admin_soft urls in your Django Project urls.py file

    from django.urls import path, include

    urlpatterns = [
        ...
        path('', include('admin_soft.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/


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:

< LIBRARY_ROOT >                      # This exists in ENV: LIB/admin_soft
   |
   |-- 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 the templates DIRECTORY inside your app
  • Step 2: configure the project to use this new template directory
    • Edit settings.py TEMPLATES section
  • Step 3: copy the footer.html from the original location (inside your ENV) and save it to the YOUR_APP/templates DIR
    • Source PATH: <YOUR_ENV>/LIB/admin_soft/includes/footer.html
    • Destination PATH: YOUR_APP/templates/includes/footer.html
  • 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.


Recompile SCSS

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
$ vi admin_soft/static/scss/soft-ui-dashboard/_variables.scss # edit variables 
$ gulp                                                        # SCSS to CSS translation

The _variables.scss content defines the primary and secondary colors:

$primary:       #cb0c9f !default;   // EDIT for customization 
$secondary:     #8392AB !default;   // EDIT for customization 
$info:          #17c1e8 !default;   // EDIT for customization 
$success:       #82d616 !default;   // EDIT for customization 
$warning:       #fbcf33 !default;   // EDIT for customization 
$danger:        #ea0606 !default;   // EDIT for customization

PRO Version

This design is a pixel-perfect Bootstrap 5 Dashboard with a fresh, new design concept. Soft UI Dashboard 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 Soft PRO - 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 via Render

Soft UI Dashboard Pro


Django Admin Soft - Modern Admin Interface provided by AppSeed