Skip to content

Latest commit

 

History

History
178 lines (124 loc) · 4.69 KB

README.md

File metadata and controls

178 lines (124 loc) · 4.69 KB
Raw

Black Dashboard Flask/Jinja

Open-source Flask/Jinja Template generated by AppSeed op top of Black Dashboard, a modern Bootstrap 5 dashboard design. The project is a super simple Flask project WITHOUT database, ORM, or any other hard dependency - Design from Creative-Tim.


Features

  • ✅ Up-to-date dependencies
  • ✅ Render Engine: Flask / Jinja2
  • ✅ UI Kit: Black Dashboard free version by Creative-Tim
  • ✅ Docker

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


Start with Docker

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

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

👉 Step 2 - Start the APP in Docker

$ docker-compose up --build

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


Manual Build

Download the code

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

👉 Set Up for Unix, MacOS

Install modules via VENV

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

Set Up Flask Environment

$ export FLASK_APP=run.py
$ export FLASK_ENV=development

Start the app

$ flask run

At this point, the app runs at http://127.0.0.1:5000/.


👉 Set Up for Windows

Install modules via VENV (windows)

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

Set Up Flask Environment

$ # CMD 
$ set FLASK_APP=run.py
$ set FLASK_ENV=development
$
$ # Powershell
$ $env:FLASK_APP = ".\run.py"
$ $env:FLASK_ENV = "development"

Start the app

$ flask run

At this point, the app runs at http://127.0.0.1:5000/.


Codebase Structure

The project has a simple, intuitive structure presented bellow:

< PROJECT ROOT >
   |
   |-- apps/__init__.py
   |-- apps/
   |    |-- static/
   |    |    |-- <css, JS, images>         # CSS files, Javascripts files
   |    |
   |    |-- templates/
   |         |
   |         |-- includes/                 # Page chunks, components
   |         |    |
   |         |    |-- navigation.html      # Top bar
   |         |    |-- sidebar.html         # Left sidebar
   |         |    |-- scripts.html         # JS scripts common to all pages
   |         |    |-- footer.html          # The common footer
   |         |
   |         |-- layouts/                  # App Layouts (the master pages)
   |         |    |
   |         |    |-- base.html            # Used by common pages like index, UI
   |         |    |-- base-fullscreen.html # Used by auth pages (login, register)
   |         |
   |      index.html                       # The default page
   |      page-404.html                    # Error 404 page (page not found)
   |      page-500.html                    # Error 500 page (server error)
   |         *.html                        # All other pages provided by the UI Kit
   |
   |-- requirements.txt
   |
   |-- run.py
   |
   |-- ************************************************************************

✨ PRO Version

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

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


Black UI Dashboard PRO Flask


Black Dashboard Flask/Jinja - Open-source starter crafted by AppSeed.