https://github.com/app-generator/jinja-black-dashboard
Jinja Template - Black Dashboard | AppSeed
https://github.com/app-generator/jinja-black-dashboard
appseed black-dashboard jinja2-template
Last synced: 7 months ago
JSON representation
Jinja Template - Black Dashboard | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/jinja-black-dashboard
- Owner: app-generator
- License: other
- Created: 2020-07-29T03:45:23.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-01T23:26:05.000Z (over 2 years ago)
- Last Synced: 2025-03-11T05:55:53.168Z (7 months ago)
- Topics: appseed, black-dashboard, jinja2-template
- Language: CSS
- Homepage: https://appseed.us/product/black-dashboard/flask/
- Size: 11.2 MB
- Stars: 12
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Black Dashboard](https://appseed.us/product/black-dashboard/flask/) Flask/Jinja
Open-source **Flask/Jinja Template** generated by `AppSeed` op top of **[Black Dashboard](https://appseed.us/product/black-dashboard/flask/)**, 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](https://www.creative-tim.com/product/black-dashboard?AFFILIATE=128200)**.
- 👉 [Black Dashboard Flask](https://appseed.us/product/black-dashboard/flask/) - Product page
- 🛒 **[Black Dashboard Flask PRO](https://appseed.us/product/black-dashboard-pro/flask/)** - `Premium Version`
> Features
- ✅ `Up-to-date dependencies`
- ✅ Render Engine: Flask / [Jinja2](https://jinja.palletsprojects.com/)
- ✅ UI Kit: [Black Dashboard](https://www.creative-tim.com/product/black-dashboard?AFFILIATE=128200) `free version` by Creative-Tim
- ✅ `Docker`
## Start with `Docker`
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
```bash
$ git clone https://github.com/app-generator/jinja-black-dashboard.git
$ cd jinja-black-dashboard
```
> 👉 **Step 2** - Start the APP in `Docker`
```bash
$ docker-compose up --build
```
Visit `http://localhost:5085` in your browser. The app should be up & running.
## Manual Build
> Download the code
```bash
$ git clone https://github.com/app-generator/jinja-black-dashboard.git
$ cd jinja-black-dashboard
```
### 👉 Set Up for `Unix`, `MacOS`
> Install modules via `VENV`
```bash
$ virtualenv env
$ source env/bin/activate
$ pip3 install -r requirements.txt
```
> Set Up Flask Environment
```bash
$ export FLASK_APP=run.py
$ export FLASK_ENV=development
```
> Start the app
```bash
$ 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
```bash
$ # CMD
$ set FLASK_APP=run.py
$ set FLASK_ENV=development
$
$ # Powershell
$ $env:FLASK_APP = ".\run.py"
$ $env:FLASK_ENV = "development"
```
> Start the app
```bash
$ 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:
```bash
< PROJECT ROOT >
|
|-- apps/__init__.py
|-- apps/
| |-- static/
| | |-- # 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](https://appseed.us/product/black-dashboard-pro/flask/) - Product Page
- 👉 [Black UI Dashboard PRO Flask](https://flask-black-dashboard-pro.appseed-srv1.com/) - LIVE Demo
---
[Black Dashboard](https://appseed.us/product/black-dashboard/flask/) Flask/Jinja - Open-source starter crafted by **[AppSeed](https://appseed.us)**.