由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 應用程式產生器提供。