Skip to content

app-generator/django-argon-dashboard

Repository files navigation

Open-source Django Dashboard project crafted on top of Argon Dashboard, an open-source Bootstrap 5 design from Creative-Tim. The product is designed to deliver the best possible user experience with highly customizable feature-rich pages. Material Material has easy and intuitive responsive design whether it is viewed on retina screens or laptops.


Features

Have questions? Contact Support (Email & Discord) provided by AppSeed

Free Version PRO Version Custom Development
βœ“ Django 4.2.9 Everything in Free, plus: Everything in PRO, plus:
βœ“ Best Practices βœ… Premium Bootstrap 5 Design βœ… 1mo Custom Development
βœ“ Bootstrap 5, Material Design βœ… OAuth Google, GitHub βœ… Team: PM, Developer, Tester
βœ“ CI/CD Flow via Render βœ… API, Charts βœ… Weekly Sprints
βœ“ Docker βœ… DataTables (Filters, Export) βœ… Technical SPECS
- βœ… Celery βœ… Documentation
- βœ… Media Files Manager βœ… 30 days Delivery Warranty
- βœ… Extended User Profiles -
- βœ… Private REPO Access -
- βœ… PRO Support - Email & Discord -
- βœ… AWS, DO, Azure Deploy Assistance -
------------------------------------ ------------------------------------ ------------------------------------
βœ“ LIVE Demo πŸš€ LIVE Demo πŸ›’ Order: $4,999 (GUMROAD)

Argon Dashboard 2 - Free Starter.


Manual Build

πŸ‘‰ Download the code

$ git clone https://github.com/app-generator/django-argon-dashboard.git
$ cd django-argon-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/.


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_argon
< 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-fullscreen.html # Masterpage for Auth Pages
   |    |
   |    |-- pages/       
   |         |-- dashboard.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_argon/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.


Recompile SCSS

The SCSS/CSS files used to style the Ui are saved in the static/assets directory. In order to update the Ui colors (primary, secondary) this procedure needs to be followed.

$ yarn # install modules
$ # # edit variables 
$ vi static/assets/scss/argon-dashboard/custom/_variables.scss 
$ gulp # SCSS to CSS translation

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

$primary:       #5e72e4 !default; // EDIT for customization
$secondary:     #8392ab !default; // EDIT for customization
$info:          #11cdef !default; // EDIT for customization
$success:       #2dce89 !default; // EDIT for customization
$warning:       #fb6340 !default; // EDIT for customization
$danger:        #f5365c !default; // EDIT for customization

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.


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

Argon Dashboard 2 PRO - Automotive (Premium Bootstrap 5 Design).



Django Argon Dashboard - Minimal Django core provided by AppSeed