Skip to content

Latest commit

 

History

History
208 lines (152 loc) · 7.43 KB

README.md

File metadata and controls

208 lines (152 loc) · 7.43 KB
Raw

Django v5 Volt Dashboard

Open-source Django Dashboard built on top of a modern design. 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. There are over 100 free Bootstrap 5 components included, including buttons, alerts, modals, and date pickers.


Features:

  • ✅ Up-to-date Dependencies
  • ✅ Theme: Django Admin Volt
  • ✅ Authentication: Django.contrib.AUTH, Registration
  • 🚀 Deployment
    • CI/CD flow via Render

Django v5 Volt Dashboard - Full-Stack Starter generated by AppSeed.


Manual Build

👉 Download the code

$ git clone https://github.com/app-generator/django-volt-dashboard.git
$ cd django-volt-dashboard

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


Deploy on Render

At this point, the product should be LIVE.


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:

# This exists in ENV: LIB/admin_volt
< UI_LIBRARY_ROOT >                     
   |
   |-- templates/                    # Root Templates Folder 
   |    |          
   |    |-- accounts/       
   |    |    |-- sign-in.html        # Sign IN Page
   |    |    |-- sign-up.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          # Index Page (presentation)
   |         |-- settings.html       # Settings  Page
   |         |-- dashboard.html      # Dashboard 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_volt/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.


PRO Version

This design is a pixel-perfect Bootstrap 5 Dashboard with a fresh, new design inspired by Google's Material Design. Volt 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 Volt - 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

Volt Dashboard PRO - Starter generated by AppSeed.


Django Volt Dashboard - Django starter provided by AppSeed