Skip to content

creativetimofficial/material-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 built on top of Material 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.

NOTE: Starter provided in partnership with App-Generator, an open-source platform for developers


Features:

  • Simple, Easy-to-Extend Codebase
  • Material Dashboard design Integration
  • Bootstrap CSS Styling
  • Session-based Authentication, Password recovery
  • DB Persistence: SQLite (default), can be used with MySql, PgSql
  • Apps:
    • DEMO Dynamic DataTables - generate server-side datatables without coding
    • DEMO Dynamic APIs - Expose secure APIs without coding
    • DEMO Charts - powered by ApexCharts
  • Django CLI Package
    • Commit/rollback Git Changes
    • Backup & restore DB
    • Interact with Django Core
    • Manage Environment
    • Manage Dependencies
  • Deployment
    • Docker/Docker Compose Scripts
    • CI/CD for Render
  • Vite for assets management

Django Material Dashboard - Open-Source Django Starter


Table of Contents


Demo

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


Quick start

πŸ‘‰ Download the code

$ git clone https://github.com/creativetimofficial/material-dashboard-django.git
$ cd material-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 >
   |
   |-- config/                            
   |    |-- settings.py                  # Project Configuration  
   |    |-- urls.py                      # Project Routing
   |
   |-- apps/
   |    |-- charts                        
   |    |-- dyn_api                      # APP Routing
   |    |-- dyn_dt                       # APP Models 
   |    |-- pages                        # Tests  
   |     
   |-- requirements.txt                  # Project Dependencies
   |
   |-- env.sample                        # ENV Configuration (default values)
   |-- manage.py                         # Start the app - Django default start script
   |
   |-- ************************************************************************

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 Material 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 Material 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.

Support

Being a product that is actively supported and improved, feel free to contact us using these funnels:

  • Creative-Tim Discord Server - for general product assistance and UI/UX
  • App Generator Discord Server - for Django specific questions and assistance.

Licensing


Useful Links


Social Media



Material Dashboard Django - Provided by Creative Tim and App-Generator.

Packages

No packages published

Contributors 2

  •  
  •  

Languages