Skip to content

app-generator/flask-v3-material-kit

Repository files navigation

Flask v3 Material Kit

Open-source Flask/Jinja Template provided by AppSeed on top of Material Kit, a modern Bootstrap 5 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 using a Flask v3.0.0 compatible stack
  • ✅ Render Engine: Flask / Jinja2
  • UI Kit: Volt Dashboard by Themesberg
  • Docker
  • CI/CD via Render

Material Kit - 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/flask-v3-material-kit.git $ cd flask-v3-material-kit

👉 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/flask-v3-material-kit.git $ cd flask-v3-material-kit

👉 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 | |-- ************************************************************************

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

Material Kit 2 is a premium design crafted by the Creative-Tim agency on top of Bootstrap 5 Framework. Designed for those who like bold elements and beautiful websites, Material Kit 2 is made of hundreds of elements, designed blocks, and fully coded pages built with an impressive level of quality.

Mk2 PRO - Premium Seed project by AppSeed.



Material Kit - Open-source Flask v3 starter provided by AppSeed.