Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/app-generator/sample-flask-blueprints
Flask Sample - Define a new Blueprint | AppSeed
https://github.com/app-generator/sample-flask-blueprints
appseed-sample blueprints flask-blueprint flask-blueprint-tutorial flask-blueprints flask-sample
Last synced: 14 days ago
JSON representation
Flask Sample - Define a new Blueprint | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/sample-flask-blueprints
- Owner: app-generator
- License: other
- Created: 2021-04-15T09:11:22.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-01-05T07:41:25.000Z (12 months ago)
- Last Synced: 2024-12-15T21:19:04.302Z (19 days ago)
- Topics: appseed-sample, blueprints, flask-blueprint, flask-blueprint-tutorial, flask-blueprints, flask-sample
- Language: HTML
- Homepage: https://appseed.us/product/atlantis-dark/flask/
- Size: 11.5 MB
- Stars: 9
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Atlantis Lite Flask](https://appseed.us/product/atlantis-dark/flask/)
Open-source dashboard generated by AppSeed in **Flask** Framework. **[Atlantis Lite](https://appseed.us/product/atlantis-dark/flask/)** (Dark Design) is a free bootstrap 4 admin dashboard that is beautifully and elegantly designed to display various metrics, numbers or data visualization.
- 👉 [Atlantis Dark Flask](https://appseed.us/product/atlantis-dark/flask/) - Product page
- 👉 [Atlantis Dark Flask](https://flask-atlantis-dark.appseed-srv1.com/) - LIVE Demo
## Adding a new Blueprint
This sample shows how to define a new **blueprint** and use it on top of an [existing starter](https://appseed.us/admin-dashboards/flask-dashboard-atlantis-dark). Steps:
- Create a new [directory](https://github.com/app-generator/sample-flask-blueprints/tree/master/app/files) for the **blueprint** with files:
- **__init__.py** - declare the Blueprint
- **routes.py** - the routing rules handled by the new **Blueprint**
- The route **/list-html** will serve a simple HTML
- [list-html](https://github.com/app-generator/flask-atlantis-bp/blob/master/app/home/templates/list-index.html)```html
...
...
```
![Flask Dashboard Atlantis - Template project provided by AppSeed.](https://raw.githubusercontent.com/app-generator/flask-dashboard-atlantis-dark/master/media/flask-dashboard-atlantis-dark-screen.png)
## Manual Build
```bash
$ # Get the code
$ git clone https://github.com/app-generator/sample-flask-blueprints.git
$ cd sample-flask-blueprints
$
$ # Virtualenv modules installation (Unix based systems)
$ virtualenv env
$ source env/bin/activate
$
$ # Virtualenv modules installation (Windows based systems)
$ # virtualenv env
$ # .\env\Scripts\activate
$
$ # Install modules - SQLite Database
$ pip3 install -r requirements.txt
$
$ # OR with PostgreSQL connector
$ # pip install -r requirements-pgsql.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"
$
$ # Start the application (development mode)
$ # --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 dashboard 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.
## Codebase Structure
The project is coded using blueprints, app factory pattern, dual configuration profile (development and production) and an intuitive structure presented bellow:
> Simplified version
```bash
< PROJECT ROOT >
|
|-- app/ # Implements app logic
| |-- base/ # Base Blueprint - handles the authentication
| |-- home/ # Home Blueprint - serve UI Kit pages
| |
| __init__.py # Initialize the app
|
|-- requirements.txt # Development modules - SQLite storage
|-- requirements-mysql.txt # Production modules - Mysql DMBS
|-- requirements-pqsql.txt # Production modules - PostgreSql DMBS
|
|-- .env # Inject Configuration via Environment
|-- config.py # Set up the app
|-- run.py # Start the app - WSGI gateway
|
|-- ************************************************************************
```
> The bootstrap flow
- `run.py` loads the `.env` file
- Initialize the app using the specified profile: *Debug* or *Production*
- If env.DEBUG is set to *True* the SQLite storage is used
- If env.DEBUG is set to *False* the specified DB driver is used (MySql, PostgreSQL)
- Call the app factory method `create_app` defined in app/__init__.py
- Redirect the guest users to Login page
- Unlock the pages served by *home* blueprint for authenticated users
> App / Base Blueprint
The *Base* blueprint handles the authentication (routes and forms) and assets management. The structure is presented below:
```bash
< PROJECT ROOT >
|
|-- app/
| |-- home/ # Home Blueprint - serve app pages (private area)
| |-- base/ # Base Blueprint - handles the authentication
| |-- static/
| | |-- # CSS files, Javascripts files
| |
| |-- templates/ # Templates used to render pages
| |
| |-- includes/ #
| | |-- 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 # Registration page
|
|-- requirements.txt # Development modules - SQLite storage
|-- requirements-mysql.txt # Production modules - Mysql DMBS
|-- requirements-pqsql.txt # Production modules - PostgreSql DMBS
|
|-- .env # Inject Configuration via Environment
|-- config.py # Set up the app
|-- run.py # Start the app - WSGI gateway
|
|-- ************************************************************************
```
> App / Home Blueprint
The *Home* blueprint handles UI Kit pages for authenticated users. This is the private zone of the app - the structure is presented below:
```bash
< PROJECT ROOT >
|
|-- app/
| |-- base/ # Base Blueprint - handles the authentication
| |-- home/ # Home Blueprint - serve app pages (private area)
| |
| |-- templates/ # UI Kit Pages
| |
| |-- index.html # Default page
| |-- page-404.html # Error 404 - mandatory page
| |-- page-500.html # Error 500 - mandatory page
| |-- page-403.html # Error 403 - mandatory page
| |-- *.html # All other HTML pages
|
|-- requirements.txt # Development modules - SQLite storage
|-- requirements-mysql.txt # Production modules - Mysql DMBS
|-- requirements-pqsql.txt # Production modules - PostgreSql DMBS
|
|-- .env # Inject Configuration via Environment
|-- config.py # Set up the app
|-- run.py # Start the app - WSGI gateway
|
|-- ************************************************************************
```
## Credits & Links
- [Flask Framework](https://www.palletsprojects.com/p/flask/) - The offcial 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
---
[Atlantis Lite Flask](https://appseed.us/product/atlantis-dark/flask/) - Provided by **[AppSeed](https://appseed.us)**.