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 キット ページを処理します。これはアプリのプライベート ゾーンであり、その構造を以下に示します。
< 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、Heraku、Gunicorn、Waittress で実行される基本構成が提供されています。
アプリケーションは 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
にアクセスします。アプリは起動して実行されているはずです。
Waittress (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 App Generatorによって提供されます。