https://github.com/app-generator/jinja-materialpro
Jinja2 Template - Material Dashboard PRO (by WrapPixel) | AppSeed
https://github.com/app-generator/jinja-materialpro
appseed commercial jinja2 jinja2-template material-design
Last synced: 6 months ago
JSON representation
Jinja2 Template - Material Dashboard PRO (by WrapPixel) | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/jinja-materialpro
- Owner: app-generator
- License: other
- Created: 2020-06-26T09:27:02.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-29T10:11:30.000Z (over 4 years ago)
- Last Synced: 2025-04-06T18:13:32.071Z (6 months ago)
- Topics: appseed, commercial, jinja2, jinja2-template, material-design
- Homepage: https://jinja2-material-dashboard-wpx-pro.appseed.us
- Size: 1.74 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Jinja Material PRO Wpx
> Template [boilerplate code](https://appseed.us/boilerplate-code) used by [AppSeed](https://appseed.us) to generate simple starters coded in [Flask](https://palletsprojects.com/p/flask/) - Features:
- UI Kit: **MaterialPro Dashboard** (Premium Version) by **WrapPixel**
- Render Engine: Flask / [Jinja2](https://jinja.palletsprojects.com/)
- Deployment scripts: Docker, Gunicorn/Nginx, HEROKU
- Support via **Github** (issues tracker) and [Discord](https://discord.gg/fZC6hup).
> Links
- [Material PRO Wpx Jinja](https://jinja-material-wpx-pro.appseed-srv1.com) - LIVE Demo
- [Material PRO Wpx Flask](https://appseed.us/admin-dashboards/flask-material-dashboard-wpx-pro) - Full-stack version (Flask)
- [Material PRO Wpx Django](https://appseed.us/admin-dashboards/django-material-dashboard-wpx-pro) - Full-stack version (Django)
## UI Kit - [MaterialPro Bootstrap Admin](https://www.wrappixel.com/templates/materialpro/?ref=appseed)
*Vendor Notes* - WrapPixel’s MaterialPro Bootstrap Admin is a premium bootstrap material design template comes packed with new, fresh, and attractive designs and ready-to-use components. Based on the popular Bootstrap 4 framework and inspired by Google’s material design, the materialPro Bootstrap Admin template is bundled with multiple third-party plugins that make it an excellent standalone solution.
[MaterialPro Bootstrap Admin](https://www.wrappixel.com/templates/materialpro/?ref=appseed) Bootstrap Admin dashboard is versatile, user-friendly and has a clean code structure that optimizes the development cost and time. The smoothness and efficiency in using a customizable admin dashboard are felt with the reliable design inspiration by Google’s material design.
> Links
- [MaterialPro Bootstrap Admin](https://www.wrappixel.com/templates/materialpro/) - product page
- [MaterialPro Bootstrap Admin Docs](https://www.wrappixel.com/demos/admin-templates/material-pro/Documentation/document.html)
## Build from sources
```bash
$ # Clone the sources
$ git clone https://github.com/app-generator/priv-jinja-material-wpx-pro.git
$ cd priv-jinja-material-wpx-pro
$
$ # Virtualenv modules installation (Unix based systems)
$ virtualenv env
$ source env/bin/activate
$
$ # Virtualenv modules installation (Windows based systems)
$ # virtualenv env
$ # .\env\Scripts\activate
$
$ # Install requirements
$ pip3 install -r requirements.txt
$
$ # Set the FLASK_APP environment variable
$ (Unix/Mac) export FLASK_APP=run.py
$ (Windows) set FLASK_APP=run.py
$ (Powershell) $env:FLASK_APP = ".\run.py"
$
$ # Set up the DEBUG environment
$ # (Unix/Mac) export FLASK_ENV=development
$ # (Windows) set FLASK_ENV=development
$ # (Powershell) $env:FLASK_ENV = "development"
$
$ # Run the Jinja Template
$ # --host=0.0.0.0 - expose the app on all network interfaces (default 127.0.0.1)
$ # --port=5000 - specify the app port (default 5000)
$ flask run --host=0.0.0.0 --port=5000
$
$ # Access the UI in browser: http://127.0.0.1:5000/
```
## Code-base structure
The project has a simple structure, represented as bellow:
```bash
< PROJECT ROOT >
|
|-- app/__init__.py
|-- app/
| |-- 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
| | login.html # Auth Login Page
| | register.html # Auth Registration 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
|
|-- ************************************************************************
```
## Deployment
The project comes with a basic configuration for [Docker](https://www.docker.com/), [Gunicorn](https://gunicorn.org/), and [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/).
### [Docker](https://www.docker.com/) execution
---
The steps to start the template using Docker:
> Get the code
```bash
$ git clone https://github.com/app-generator/priv-jinja-material-wpx-pro.git
$ cd priv-jinja-material-wpx-pro
```
> Start the app in Docker
```bash
$ sudo docker-compose pull && sudo docker-compose build && sudo docker-compose up -d
```
Visit `http://localhost:5005` in your browser. The app should be up & running.
### [Gunicorn](https://gunicorn.org/)
---
Gunicorn 'Green Unicorn' is a Python WSGI HTTP Server for UNIX.
> Install using pip
```bash
$ pip install gunicorn
```
> Start the app using gunicorn binary
```bash
$ gunicorn --bind 0.0.0.0:8001 run:app
Serving on http://localhost:8001
```
Visit `http://localhost:8001` in your browser. The app should be up & running.
### [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/)
---
Waitress (Gunicorn equivalent for Windows) is meant to be a production-quality pure-Python WSGI server with very acceptable performance. It has no dependencies except ones that live in the Python standard library.
> Install using pip
```bash
$ pip install waitress
```
> Start the app using [waitress-serve](https://docs.pylonsproject.org/projects/waitress/en/stable/runner.html)
```bash
$ waitress-serve --port=8001 run:app
Serving on http://localhost:8001
```
Visit `http://localhost:8001` in your browser. The app should be up & running.
## Credits & Links
- [Flask Framework](https://www.palletsprojects.com/p/flask/) - The official website
---
[Material Dashboard PRO Wpx Jinja](https://jinja-material-wpx-pro.appseed-srv1.com) - Provided by **AppSeed** [App Generator](https://appseed.us/app-generator).