Skip to content

Latest commit

 

History

History
193 lines (132 loc) · 4.69 KB

README.md

File metadata and controls

193 lines (132 loc) · 4.69 KB
Raw

Volt Dashboard Flask/Jinja

Open-source Flask/Jinja Template generated by AppSeed op top of Volt Dashboard, a modern Bootstrap 5 dashboard design. The project is a super simple Flask project WITHOUT database, ORM, or any other hard dependency. The project can be used as a codebase for future project or to migrate the Jinja files and assets to a legacy Python-based project that uses Jinja as template engine (Flask, Bottle, Django).


Built with Volt Dashboard Generator

  • Timestamp: 2022-05-25 22:16
  • Build ID: 52ce365f-f102-40c1-9ccb-52b7e328ba5e
  • Free Support (registered users) via Email and Discord

Features

  • Up-to-date dependencies
  • Render Engine: Flask / Jinja2

Volt Dashboard - Full-Stack Starter generated by AppSeed.


✨ 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-volt-dashboard.git
$ cd jinja-volt-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:85 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-volt-dashboard.git
$ cd jinja-volt-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
   |         |    |-- 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:

Volt Pro is a premium Bootstrap 5 Admin Dashboard featuring over 800 components, 20 example pages and 10 fully customized plugin written in Vanilla Javascript.


Flask Volt PRO - Premium Starter.


Volt Dashboard Flask/Jinja - Open-source starter generated by AppSeed Generator.