Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/app-generator/flask-v3-material-kit

Flask v3 - Material Kit Design (Free Sample) | AppSeed
https://github.com/app-generator/flask-v3-material-kit

flask flask-bootstrap flask-bs5 flask-v3 flask-v3-sample flask-v3-template flask3-bootstrap flask3-sample

Last synced: 18 days ago
JSON representation

Flask v3 - Material Kit Design (Free Sample) | AppSeed

Awesome Lists containing this project

README

        

# 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](https://www.creative-tim.com/?AFFILIATE=128200)**.

> Features

- ✅ `Up-to-date dependencies` using a **Flask v3.0.0** compatible stack
- ✅ Render Engine: Flask / [Jinja2](https://jinja.palletsprojects.com/)
- ✅ **UI Kit**: Volt Dashboard by Themesberg
- ✅ `Docker`
- ✅ `CI/CD` via Render

![Material Kit - Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/167396765-c88b7a95-155f-4236-8691-7b80fa2d9cd9.png)


## Start with `Docker`

> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)

```bash
$ git clone https://github.com/app-generator/flask-v3-material-kit.git
$ cd flask-v3-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.


## Manual Build

> Download the code

```bash
$ 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`

```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/`.


## Codebase Structure

The project has a simple, intuitive structure presented bellow:

```bash
< PROJECT ROOT >
|
|-- apps/__init__.py
|-- apps/
| |-- 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
| 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
|
|-- ************************************************************************
```


## [Flask Material Kit2](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 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
- 👉 [Flask Material Kit2 PRO](https://flask-material-kit2-pro.appseed-srv1.com/) - LIVE Demo

![Mk2 PRO - Premium Seed project by AppSeed.](https://user-images.githubusercontent.com/51070104/168224733-b054bb46-d454-4aea-bb94-2d01bf4760d2.png)


---
Material Kit - Open-source Flask v3 starter provided by **[AppSeed](https://appseed.us/)**.