Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/app-generator/flask-material-kit
Flask Boilerplate - Material Kit Design | AppSeed
https://github.com/app-generator/flask-material-kit
flask-app flask-template material-design
Last synced: about 1 month ago
JSON representation
Flask Boilerplate - Material Kit Design | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/flask-material-kit
- Owner: app-generator
- License: other
- Created: 2019-09-05T07:15:39.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-21T10:17:33.000Z (2 months ago)
- Last Synced: 2024-12-15T21:18:38.362Z (about 2 months ago)
- Topics: flask-app, flask-template, material-design
- Language: SCSS
- Homepage: https://appseed.us/product/material-kit/flask/
- Size: 12.3 MB
- Stars: 74
- Watchers: 5
- Forks: 32
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Flask Material Kit](https://appseed.us/product/material-kit/flask/)
`Open-Source` **[Flask App](https://appseed.us/apps/flask/)** crafted on top of a modern **Bootstrap 5** UI. Designed for those who like bold elements and beautiful websites, **Material Kit 2** is ready to help you create stunning websites and web apps. `Material Kit 2` is built with over 60 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.
- 👉 [Flask Material Kit](https://appseed.us/product/material-kit/flask/) - product page
- 👉 [Flask Material Kit](https://flask-material-kit.appseed-srv1.com/) - LIVE App
## Deploy on `Render` (free plan)
[](https://render.com/deploy)
## Start with `Docker`
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
```bash
$ git clone https://github.com/app-generator/flask-material-kit.git
$ cd flask-material-kit
```
> 👉 **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.
## ✨ How to use it
> Download the code
```bash
$ git clone https://github.com/app-generator/flask-material-kit.git
$ cd flask-material-kit
```
### 👉 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_DEBUG=True
```
> 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_DEBUG=True
$
$ # Powershell
$ $env:FLASK_APP = ".\run.py"
$ $env:FLASK_DEBUG = "True"
```
> 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`
## Codebase 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](https://appseed.us/product/material-kit2-pro/flask/) `PRO`
> For more components, pages and priority on support, feel free to take a look at this amazing 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.
- 👉 [Flask Material Kit2 PRO](https://appseed.us/product/material-kit2-pro/flask/) - product page
- ✅ `Enhanced UI` - more pages and components
- ✅ `Priority` on support
---
[Flask Material Kit](https://appseed.us/product/material-kit/flask/) - Open-source Flask Starter provided by **[App Generator](https://app-generator.dev/)**.