Skip to content

app-generator/jinja-berry-dashboard

Repository files navigation

Open-source Flask/Jinja project crafted on top of Berry Dashboard, an open-source Boostrap 5 design from CodedThemes The product is designed to deliver the best possible user experience with highly customizable feature-rich pages. Berry has easy and intuitive responsive design whether it is viewed on retina screens or laptops.


Features

  • Up-to-date dependencies
  • ✅ Render Engine: Flask / Jinja2
  • UI Kit: Berry BS5 v1.0.1 by CodedThemes
    • Persistent Dark-Mode

Berry Bootstrap 5 - Dark-Mode ready, Open-source Template.


✨ Start the app in Docker

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

$ # Get the code
$ git clone https://github.com/app-generator/jinja-berry-dashboard.git
$ cd jinja-berry-dashboard

Step 2 - Edit .env and set DEBUG=True. This will activate the SQLite persistance.

DEBUG=True

Step 3 - Start the APP in Docker

$ docker-compose up --build 

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


✨ How to use it

Download the code

$ # Get the code
$ git clone https://github.com/app-generator/jinja-berry-dashboard.git
$ cd jinja-berry-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/.


✨ Code-base 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
   |         |    |-- 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
   |         |
   |         |-- home/                     # UI Kit Pages
   |              |-- index.html           # default page
   |              |-- page-404.html        # 404 error page
   |              |-- *.html               # Used by common pages like index, UI
   |
   |-- requirements.txt
   |
   |-- run.py
   |
   |-- ************************************************************************

Screenshots

Berry Bootstrap 5 - Sign IN, Open-source Starter by AppSeed.


Flask/Jinja Berry - Icons Page

Berry Bootstrap 5 - UI Icons page, Open-source Starter by AppSeed


Flask/Jinja Berry - Colors page

Berry Bootstrap 5 - Colors page, Open-source Starter by AppSeed



Flask/Jinja Berry - Minimal Flask starter provided by AppSeed