Giter VIP home page Giter VIP logo

app-generator / django-material-dashboard Goto Github PK

View Code? Open in Web Editor NEW
234.0 10.0 81.0 28.58 MB

Django Dashboard - Material Design | AppSeed

Home Page: https://appseed.us/product/material-dashboard/django/

License: Other

Dockerfile 0.03% Shell 0.01% Python 0.57% HTML 1.26% CSS 38.63% JavaScript 21.38% SCSS 38.11%
material-design django-bootstrap django-bootstrap-v5 django-bootstrap5 django-bs5 django-material django-starter django-starter-template django-material-admin django-material-dashboard

django-material-dashboard's Introduction

Open-source Django Dashboard crafted on top of Material 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 Dashboard has an easy and intuitive responsive design, whether 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 โœ… 1 Week Custom Development
โœ“ Bootstrap 5, Material Design โœ… OAuth GitHub โœ… Team: PM, Developer, Tester
โœ“ CI/CD Flow via Render โœ… API, Charts โœ… Weekly Sprints
โœ“ Docker โœ… DataTables (Filters, Export) โœ… Technical SPECS
โœ“ Free Support (GitHub Issues) โœ… Celery โœ… Documentation
- โœ… Media Files Manager โœ… 30 days Delivery Warranty
- โœ… Extended User Profiles โœ… CI/CD for AWS, DO (Extra)
- โœ… Private REPO Access -
- โœ… Premium Support -
------------------------------------ ------------------------------------ ------------------------------------
โœ“ LIVE Demo ๐Ÿš€ LIVE Demo ๐Ÿ›’ Order: $999 (GUMROAD)

Material Dashboard - Full-Stack Starter generated by AppSeed.


Manual Build

๐Ÿ‘‰ Download the code

$ git clone https://github.com/app-generator/django-material-dashboard.git
$ cd django-material-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, 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_material
< UI_LIBRARY_ROOT >                      
   |
   |-- 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-auth.html       # Masterpage for Auth Pages
   |    |
   |    |-- pages/       
   |         |-- index.html           # Dashboard Page
   |         |-- profile.html         # Profile 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_material/template/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.


CSS Styling

The UI can be customized via the SCSS file. This setup was tested using:

  • Node v16.15.0
  • Yarn 1.22.18
  • Gulp CLI version: 2.3.0, Local version: 4.0.2
$ cd static
$ yarn                                       # Install Modules 
$ vi scss/material-dashboard/_variables.scss # Edit primary, secondary colors
$ gulp                                       # Regenerate CSS files   

NOTE, once the CSS files are successfully regenerated, force a hard refresh in the browser (Shift + F5 in Chrome).

The relevant lines in _variables.scss are highlighted below:

// _variables.scss, LINES 56 -> 63
$primary:       #e91e63 !default;   // EDIT & Recompile SCSS
$secondary:     #7b809a !default;   // EDIT & Recompile SCSS
$info:          #1A73E8 !default;   // EDIT & Recompile SCSS
$success:       #4CAF50 !default;   // EDIT & Recompile SCSS
$warning:       #fb8c00 !default;   // EDIT & Recompile SCSS
$danger:        #F44335 !default;   // EDIT & Recompile SCSS
$light:         $gray-200 !default; // EDIT & Recompile SCSS
$dark:          $h-color !default;  // EDIT & Recompile SCSS

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. Material 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
  • Database: SQLite, PgSQL, MySql
  • Authentication
    • Session-Based authentication
    • Social Login: Github & Google
  • User Extended profile
  • API via DRF
  • DataTables
  • Charts
  • Celery
  • File Manager
  • i18n (internationalization)
  • Docker

Material Dashboard 2 Pro



Django Material Dashboard - Free Starter provided by AppSeed

django-material-dashboard's People

Contributors

app-generator avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

django-material-dashboard's Issues

Customizing static files

Dear app-generator,

Can you please help me with how to customize the static files? I know how I can customize the footer.html etc but not how to customize static files. I would like to customize the UI a little bit. Thank you in advance :)

Kind regards,

Mike

Django Dashboard Material - Can't register a new user with docker

Request Method: | POST
http://localhost:5005/register/
3.0.4
TypeError
'sslmode' is an invalid keyword argument for this function
/usr/local/lib/python3.6/site-packages/django/db/backends/sqlite3/base.py in get_new_connection, line 199
/usr/local/bin/python
3.6.10
['/', '/usr/local/bin', '/usr/local/lib/python36.zip', '/usr/local/lib/python3.6', '/usr/local/lib/python3.6/lib-dynload', '/usr/local/lib/python3.6/site-packages']
Wed, 11 Mar 2020 15:04:05 +0000

Trace:

http://dpaste.com/00VSJQT

customizing menu_items

hi,
i would like to know how we can customize the menu items in sidebar
as i inspected the code is getting app labels and lists the models of the app under the app label with querys thats great but lets say for example i dont want it to include one model or lets say i want to gather models under a diffrent name. i know this might broke the dynamic structure but thats what i need.
i would be appriciated if you help me with that.

Logout doesnt work

Logout function doesn't work when installing the demo. Im not adverse to paying for tbe pro version but Idon't want to pay if I'm debugging.

adding the content of the django apps to the dashboard

hi,
i would like to get help with adding the contents of my apps to the dashboard.
my project structure has apps for the each model for easy management but im having an issue about putting them to the dashboard
this is how my folder structure looks like
image

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.