Skip to content

zkn365/django-black-dashboard

 
 

Repository files navigation

Open-source Django Dashboard generated by AppSeed op top of a modern Bootstrap design. Designed for those who like bold elements and beautiful websites, Black Dashboard is ready to help you create stunning websites and webapps. Black Dashboard is built with over 50 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.


🚀 Built with App Generator, timestamp: 2022-05-25 10:28

  • Up-to-date dependencies
  • ✅ Database: sqlite
  • ✅ UI-Ready app, Django Native ORM
  • Session-Based authentication, Forms validation
  • Black Design - Theme for admin section

Black Dashboard - Seed project provided by AppSeed.


✨ Start the app in Docker

👉 Step 1 - Download the code from the GH repository (using GIT)

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

👉 Step 2 - Start the APP in Docker

$ docker-compose up --build 

Visit https://localhost:5085 in your browser. The app should be up & running.


✨ How to use it

Download the code

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

👉 Set Up for Unix, MacOS

Install modules via VENV

$ virtualenv env
$ source env/bin/activate
$ pip3 install -r requirements.txt

Set Up Database

$ python manage.py makemigrations
$ python manage.py migrate

Start the app

$ python manage.py runserver

At this point, the app runs at https://127.0.0.1:8000/.


👉 Set Up for Windows

Install modules via VENV (windows)

$ virtualenv env
$ .\env\Scripts\activate
$ pip3 install -r requirements.txt

Set Up Database

$ python manage.py makemigrations
$ python manage.py migrate

Start the app

$ python manage.py runserver

At this point, the app runs at https://127.0.0.1:8000/.


✨ Create Users

By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up:

  • Start the app via flask run
  • Access the registration page and create a new user:
    • https://127.0.0.1:8000/register/
  • Access the sign in page and authenticate
    • https://127.0.0.1:8000/login/

Recompile CSS

To recompile SCSS files, follow this setup:


👉 Step #1 - Install tools

  • NodeJS 12.x or higher
  • Gulp - globally
    • npm install -g gulp-cli
  • Yarn (optional)

👉 Step #2 - Change the working directory to assets folder

$ cd apps/static/assets

👉 Step #3 - Install modules (this will create a classic node_modules directory)

$ npm install
// OR
$ yarn

👉 Step #4 - Edit & Recompile SCSS files

$ gulp

The generated file is saved in static/assets/css directory.


✨ Code-base structure

The project is coded using a simple and intuitive structure presented below:

< PROJECT ROOT >
   |
   |-- core/                               # Implements app configuration
   |    |-- settings.py                    # Defines Global Settings
   |    |-- wsgi.py                        # Start the app in production
   |    |-- urls.py                        # Define URLs served by all apps/nodes
   |
   |-- apps/
   |    |
   |    |-- home/                          # A simple app that serve HTML files
   |    |    |-- views.py                  # Serve HTML pages for authenticated users
   |    |    |-- urls.py                   # Define some super simple routes  
   |    |
   |    |-- authentication/                # Handles auth routes (login and register)
   |    |    |-- urls.py                   # Define authentication routes  
   |    |    |-- views.py                  # Handles login and registration  
   |    |    |-- forms.py                  # Define auth forms (login and register) 
   |    |
   |    |-- static/
   |    |    |-- <css, JS, images>         # CSS files, Javascripts files
   |    |
   |    |-- templates/                     # Templates used to render pages
   |         |-- includes/                 # HTML chunks and components
   |         |    |-- navigation.html      # Top menu component
   |         |    |-- sidebar.html         # Sidebar component
   |         |    |-- footer.html          # App Footer
   |         |    |-- scripts.html         # Scripts common to all pages
   |         |
   |         |-- layouts/                   # Master pages
   |         |    |-- base-fullscreen.html  # Used by Authentication pages
   |         |    |-- base.html             # Used by common pages
   |         |
   |         |-- accounts/                  # Authentication pages
   |         |    |-- login.html            # Login page
   |         |    |-- register.html         # Register page
   |         |
   |         |-- home/                      # UI Kit Pages
   |              |-- index.html            # Index page
   |              |-- 404-page.html         # 404 page
   |              |-- *.html                # All other pages
   |
   |-- requirements.txt                     # Development modules - SQLite storage
   |
   |-- .env                                 # Inject Configuration via Environment
   |-- manage.py                            # Start the app - Django default start script
   |
   |-- ************************************************************************

PRO Version

For more components, pages and priority on support, feel free to take a look at this amazing starter:

Black Dashboard is a premium Bootstrap Design now available for download in Django. Made of hundred of elements, designed blocks, and fully coded pages, Black Dashboard PRO is ready to help you create stunning websites and web apps.


Black Dashboard PRO - Full-Stack Starter generated by AppSeed.



Black Dashboard Django - Open-source starter generated by AppSeed Generator.

About

Django Dashboard Black - Open-source Seed Project | AppSeed

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CSS 41.6%
  • SCSS 39.5%
  • HTML 14.1%
  • JavaScript 3.4%
  • Python 1.4%
  • Dockerfile 0.0%