由AppSeed
生成的开源Flask 仪表板采用现代设计。 AdminKit是一个专业的软件包,附带数百个 UI 组件、表单、表格、图表、页面和图标 -构建在 Bootstrap 5 之上。
特征
$ # Get the code
$ git clone https://github.com/app-generator/flask-adminkit.git
$ cd flask-adminkit
$
$ # Virtualenv modules installation (Unix based systems)
$ virtualenv env
$ source env/bin/activate
$
$ # Virtualenv modules installation (Windows based systems)
$ # virtualenv env
$ # .envScriptsactivate
$
$ # 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/
注意:要使用该应用程序,请访问注册页面并创建新用户。身份验证后,应用程序将解锁私人页面。
该项目使用蓝图、应用程序工厂模式、双配置文件(开发和生产)和如下所示的直观结构进行编码:
简化版
< 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
|
| -- ************************************************************************
引导流程
run.py
加载.env
文件create_app
应用程序/基础蓝图
基础蓝图处理身份验证(路由和表单)和资产管理。结构如下所示:
< PROJECT ROOT >
|
| -- app/
| | -- home/ # Home Blueprint - serve app pages (private area)
| | -- base/ # Base Blueprint - handles the authentication
| | -- static/
| | | -- < css, JS, images > # 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
|
| -- ************************************************************************
应用程序/家庭蓝图
主页蓝图为经过身份验证的用户处理 UI Kit 页面。这是应用程序的私人区域 - 结构如下所示:
< 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
|
| -- ************************************************************************
该应用程序提供了可在 Docker、Heroku、Gunicorn 和 Waitress 中执行的基本配置。
该应用程序可以在 Docker 容器中轻松执行。步骤:
获取代码
$ git clone https://github.com/app-generator/flask-adminkit.git
$ cd flask-adminkit
在 Docker 中启动应用程序
$ sudo docker-compose pull && sudo docker-compose build && sudo docker-compose up -d
在浏览器中访问http://localhost:5005
。该应用程序应该已启动并正在运行。
在Heroku上部署的步骤
heroku login
命令进行身份验证$ # Clone the source code:
$ git clone https://github.com/app-generator/flask-adminkit.git
$ cd flask-adminkit
$
$ # 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 'Green Unicorn' 是一个适用于 UNIX 的 Python WSGI HTTP 服务器。
使用 pip 安装
$ pip install gunicorn
使用gunicorn二进制文件启动应用程序
$ gunicorn --bind 0.0.0.0:8001 run:app
Serving on http://localhost:8001
在浏览器中访问http://localhost:8001
。该应用程序应该已启动并正在运行。
Waitress(相当于 Windows 的 Gunicorn)旨在成为一个生产质量的纯 Python WSGI 服务器,具有非常可接受的性能。除了 Python 标准库中的依赖项之外,它没有任何依赖项。
使用 pip 安装
$ pip install waitress
使用 waitress-serve 启动应用程序
$ waitress-serve --port=8001 run:app
Serving on http://localhost:8001
在浏览器中访问http://localhost:8001
。该应用程序应该已启动并正在运行。
Flask Dashboard AdminKit - 由AppSeed 应用程序生成器提供。