Skip to content

creativetimofficial/soft-ui-dashboard-django

Repository files navigation

version GitHub issues open GitHub issues closed Join the chat at https://gitter.im/NIT-dgp/General Chat

Open-source Django Template crafted on top of Soft UI Dashboard, a modern Bootstrap 5 design. Start your development with a modern Bootstrap 5 Admin template for Django. Soft UI Dashboard is built with over 70 individual components, giving you the freedom of choosing and combining. If you want to code faster, with a smooth workflow, then you should try this template carefully developed with Django, a well-known Python Framework.


Features:

  • βœ… Up-to-date Dependencies
  • βœ… Theme: Django Admin Soft
  • βœ… Authentication: Django.contrib.AUTH, Registration
  • πŸš€ Deployment

Django Soft UI Dashboard - Seed project generated by AppSeed.


Table of Contents


Demo

To authenticate use the default credentials test / PaSS_123 or create a new user on the registration page.


Quick start

πŸ‘‰ Download the code

$ git clone https://github.com/creativetimofficial/soft-ui-dashboard-django.git
$ cd soft-ui-dashboard-django

πŸ‘‰ Install modules via VENV

$ 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/.


Documentation

The documentation for the Soft UI Dashboard Django is hosted at our website.


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:

< 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 the home app
  • βœ… Step 2: configure the project to use this new template directory
    • core/settings.py TEMPLATES section
  • βœ… Step 3: copy the footer.html from the original location (inside your ENV) and save it to the home/templates DIR
    • Source PATH: <YOUR_ENV>/LIB/admin_soft/includes/footer.html
    • Destination PATH: <PROJECT_ROOT>home/templates/includes/footer.html

To speed up all these steps, the codebase is already configured (Steps 1, and 2) and a custom 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
  • Click New Blueprint Instance button.
  • Connect your repo which you want to deploy.
  • Fill the Service Group Name and click on Update Existing Resources button.
  • After that your deployment will start automatically.

At this point, the product should be LIVE.


Reporting Issues

We use GitHub Issues as the official bug tracker for the Soft UI Dashboard Django. Here are some advices for our users that want to report an issue:

  1. Make sure that you are using the latest version of the Soft UI Dashboard Django. Check the CHANGELOG from your dashboard on our website.
  2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.
  3. Some issues may be browser-specific, so specifying in what browser you encountered the issue might help.

Technical Support or Questions

If you have questions or need help integrating the product please contact us instead of opening an issue.


Licensing


Useful Links


Social Media


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

Django - Soft UI Dashboard PRO (premium starter by AppSeed & Creative-Tim



Soft UI Dashboard - Django Template - Provided by Creative Tim and AppSeed