Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/app-generator/sample-flask-htmlx-mkit
Flask HTMLx - Material Kit Design (Open-Source) | AppSeed
https://github.com/app-generator/sample-flask-htmlx-mkit
appseed-sample flask-htmx flask-sample htmlx htmx-app htmx-flask htmx-free-template htmx-starter htmx-template
Last synced: 1 day ago
JSON representation
Flask HTMLx - Material Kit Design (Open-Source) | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/sample-flask-htmlx-mkit
- Owner: app-generator
- License: other
- Created: 2022-05-01T16:39:50.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-05-04T05:23:04.000Z (over 2 years ago)
- Last Synced: 2024-10-11T04:43:40.137Z (24 days ago)
- Topics: appseed-sample, flask-htmx, flask-sample, htmlx, htmx-app, htmx-flask, htmx-free-template, htmx-starter, htmx-template
- Language: SCSS
- Homepage: https://blog.appseed.us/flask-htmlx-material-kit-design/
- Size: 6.24 MB
- Stars: 14
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-htmx - Flask HTMLX Material Kit - Simple starter powered by `Flask`, `HTMLX` and `Bootstrap 5` (Examples by Back-end / Python-based (Django, FastAPI, Flask))
README
# [Flask HTMLX](https://blog.appseed.us/flask-htmlx-material-kit-design/) Material Kit
`Open-Source` sample that uses **Flask and HTMLx** for the frontend logic. For newcomers, `Flask` is a leading web framework powered by Python and `HTMLx` is a lightweight JS utility library that allows accessing AJAX, CSS Transitions, WebSockets, and Server-Sent Events directly in HTML.
Desing is provided by `Material Kit 2`, a modern Boostrap 5 desing (also free).
> **Features**
- `Up-to-date` Dependencies
- Tech Stack:
- `Flask`: manages authentication and routing
- `HTMLx`: manages forms: `Login`, `Register` and `Contact`
- `Bootstrap 5`: UI & presentation layer
- `Auth`: Sign IN, Sign UP
- `Misc`: SQLite DB, SQLAlchemy, Forms Validation
> **Links**
- 👉 More [Flask Apps](https://appseed.us/apps/flask/) and [Dashboards](https://appseed.us/admin-dashboards/flask/) provided by AppSeed
- 👉 Free [Support](https://appseed.us/support/) via Email and [Discord](https://discord.gg/fZC6hup).
## ✨ Quick Start in `Docker`
> Get the code
```bash
$ git clone https://github.com/app-generator/sample-flask-htmlx-mkit.git
$ cd sample-flask-htmlx-mkit
```
> Start the app in Docker
```bash
$ docker-compose up --build
```
Visit `http://localhost:85` in your browser. The app should be up & running.
## ✨ Build from sources
```bash
$ # Clone the sources
$ git clone https://github.com/app-generator/sample-flask-htmlx-mkit.git
$ cd sample-flask-htmlx-mkit
$
$ # 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 application
$ # --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 app in browser: http://127.0.0.1:5000/
```
> Note: To use the app, please access the registration page and create a new user. After authentication, the app will unlock the private pages.
## ✨ Code-base structure
The project has a super simple structure, represented as bellow:
```bash
< PROJECT ROOT >
|
|-- 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)
| | |
| | |-- accounts/ # Auth Pages (login, register)
| | | |
| | | |-- login.html # Use layout `base-fullscreen.html`
| | | |-- register.html # Use layout `base-fullscreen.html`
| | |
| | |-- home/ # UI Kit Pages
| | |-- index.html # Index page
| | |-- 404-page.html # 404 page
| | |-- *.html # All other pages
| |
| config.py # Provides APP Configuration
| forms.py # Defines Forms (login, register)
| models.py # Defines app models
| views.py # Application Routes
|
|-- Dockerfile # Deployment
|-- docker-compose.yml # Deployment
|-- gunicorn-cfg.py # Deployment
|-- nginx # Deployment
| |-- appseed-app.conf # Deployment
|
|-- requirements.txt
|-- run.py
|
|-- ************************************************************************
```
## ✨ Recompile CSS
To recompile SCSS files, follow this setup:
**Step #1** - Install tools
- [NodeJS](https://nodejs.org/en/) 12.x or higher
- [Gulp](https://gulpjs.com/) - globally
- `npm install -g gulp-cli`
- [Yarn](https://yarnpkg.com/) (optional)
**Step #2** - Change the working directory to `assets` folder
```bash
$ cd app/static/assets
```
**Step #3** - Install modules (this will create a classic `node_modules` directory)
```bash
$ npm install
// OR
$ yarn
```
**Step #4** - Edit & Recompile SCSS files
```bash
$ gulp scss
```
The generated file is saved in `static/assets/css` directory.
## ✨ Deployment
The app is provided with a basic configuration to be executed in [Docker](https://www.docker.com/), [Heroku](https://www.heroku.com/), [Gunicorn](https://gunicorn.org/), and [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/).
### [Heroku](https://www.heroku.com/)
---
Steps to deploy on **Heroku**
- [Create a FREE account](https://signup.heroku.com/) on Heroku platform
- [Install the Heroku CLI](https://devcenter.heroku.com/articles/getting-started-with-python#set-up) that match your OS: Mac, Unix or Windows
- Open a terminal window and authenticate via `heroku login` command
- Clone the sources and push the project for LIVE deployment
```bash
$ # Clone the source code:
$ git clone https://github.com/app-generator/sample-flask-htmlx-mkit.git
$ cd sample-flask-htmlx-mkit
$
$ # Check Heroku CLI is installed
$ heroku -v
heroku/7.25.0 win32-x64 node-v12.13.0 # <-- All good
$
$ # Check Heroku CLI is installed
$ heroku login
$ # this commaond will open a browser window - click the login button (in browser)
$
$ # Create the Heroku project
$ heroku create
$
$ # Trigger the LIVE deploy
$ git push heroku master
$
$ # Open the LIVE app in browser
$ heroku open
```
### [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
- [Boilerplate Code](https://appseed.us/boilerplate-code) - Index provided by **AppSeed**
- [Boilerplate Code](https://github.com/app-generator/boilerplate-code) - Index published on Github
---
[Flask HTMLX](https://blog.appseed.us/flask-htmlx-material-kit-design/) Material Kit - Provided by **AppSeed** [App Generator](https://appseed.us/app-generator).