https://github.com/app-generator/flask-material-kit-pro
Flask Boilerplate - Material Kit PRO | AppSeed
https://github.com/app-generator/flask-material-kit-pro
appseed flask material-design
Last synced: 4 months ago
JSON representation
Flask Boilerplate - Material Kit PRO | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/flask-material-kit-pro
- Owner: app-generator
- License: other
- Created: 2021-11-02T15:06:53.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-02-08T17:57:13.000Z (over 3 years ago)
- Last Synced: 2025-10-07T18:51:54.457Z (9 months ago)
- Topics: appseed, flask, material-design
- Homepage: https://appseed.us/product/material-kit-pro/flask/
- Size: 17.6 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Flask Material Kit PRO](https://appseed.us/product/material-kit-pro/flask/)
Seed project generated by AppSeed in **Flask** Framework on top of **[Material Kit PRO](https://appseed.us/product/material-kit-pro/flask/)** Design (Bootstrap 4 version). Designed for those who like bold elements and beautiful websites, **Material Kit PRO** is ready to help you create stunning websites and web apps - designed by [Creative-Tim](https://www.creative-tim.com/?AFFILIATE=128200).
- 👉 [Flask Material Kit PRO](https://appseed.us/product/material-kit-pro/flask/) - product page
- 👉 [Flask Material Kit PRO](https://flask-material-kit-pro.appseed-srv1.com/) - LIVE App
- 👉 [Complete documentation](https://docs.appseed.us/products/flask-apps/material-kit-pro) - `Learn how to use and update the product`
> Features
- ✅ `Up-to-date dependencies`
- ✅ Database: `mysql`
- ✅ `DB Tools`: SQLAlchemy ORM, Flask-Migrate (schema migrations)
- ✅ Session-Based authentication (via **flask_login**), Forms validation
## ✨ Start the app in Docker
> 👉 **Step 1** - Download the [code](https://appseed.us/product/material-kit-pro/flask/) and unzip the sources (requires a `purchase`).
```bash
$ unzip flask-material-kit-pro.zip
$ cd flask-material-kit-pro
```
> 👉 **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.
## ✨ Set up the MySql Database
**Note:** Make sure your Mysql server is properly installed and accessible.
> 👉 **Step 1** - Create the MySql Database to be used by the app
- `Create a new MySql` database
- `Create a new user` and assign full privilegies (read/write)
> 👉 **Step 2** - Edit the `.env` to match your MySql DB credentials. Make sure `DB_ENGINE` is set to `mysql`.
- `DB_ENGINE` : `mysql`
- `DB_NAME` : default value = `appseed_db`
- `DB_HOST` : default value = `localhost`
- `DB_PORT` : default value = `3306`
- `DB_USERNAME`: default value = `appseed_db_usr`
- `DB_PASS` : default value = `pass`
Here is a sample:
```txt
# .env sample
DEBUG=False # False enables the MySql Persistence
DB_ENGINE=mysql # Database Driver
DB_NAME=appseed_db # Database Name
DB_USERNAME=appseed_db_usr # Database User
DB_PASS=STRONG_PASS_HERE # Password
DB_HOST=localhost # Database HOST, default is localhost
DB_PORT=3306 # MySql port, default = 3306
```
## ✨ How to use it
> Download the [code](https://appseed.us/product/material-kit-pro/flask/) and unzip the sources (requires a `purchase`).
```bash
$ unzip flask-material-kit-pro.zip
$ cd flask-material-kit-pro
```
### 👉 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/`.
### 👉 Create Users
By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up:
- Start the app via `flask run`
- Access the `registration` page and create a new user:
- `http://127.0.0.1:5000/register`
- Access the `sign in` page and authenticate
- `http://127.0.0.1:5000/login`
## ✨ Code-base structure
The project is coded using blueprints, app factory pattern, dual configuration profile (development and production) and an intuitive structure presented bellow:
```bash
< PROJECT ROOT >
|
|-- apps/
| |
| |-- home/ # A simple app that serve HTML files
| | |-- routes.py # Define app routes
| |
| |-- authentication/ # Handles auth routes (login and register)
| | |-- routes.py # Define authentication routes
| | |-- models.py # Defines models
| | |-- forms.py # Define auth forms (login and register)
| |
| |-- static/
| | |-- # CSS files, Javascripts files
| |
| |-- templates/ # Templates used to render pages
| | |-- includes/ # HTML chunks and components
| | | |-- navigation.html # Top menu component
| | | |-- sidebar.html # Sidebar component
| | | |-- footer.html # App Footer
| | | |-- scripts.html # Scripts common to all pages
| | |
| | |-- layouts/ # Master pages
| | | |-- base-fullscreen.html # Used by Authentication pages
| | | |-- base.html # Used by common pages
| | |
| | |-- accounts/ # Authentication pages
| | | |-- login.html # Login page
| | | |-- register.html # Register page
| | |
| | |-- home/ # UI Kit Pages
| | |-- index.html # Index page
| | |-- 404-page.html # 404 page
| | |-- *.html # All other pages
| |
| config.py # Set up the app
| __init__.py # Initialize the app
|
|-- requirements.txt # App Dependencies
|
|-- .env # Inject Configuration via Environment
|-- run.py # Start the app - WSGI gateway
|
|-- ************************************************************************
```
---
[Flask Material Kit PRO](https://appseed.us/product/material-kit-pro/flask/) - Seed project crafted by **[AppSeed](https://appseed.us)**.