Flask Boilerplate Dashboard Argon

Open-Source Admin Dashboard coded in Flask Web Framework on top of Argon Dashboard design, crafted by Creative-Tim agency. Dashboard features:


Flask Dashboard Argon - Open-Source Admin Panel


Setup the environment


In order to use the boilerplate, we need Python3 and virtualenv python library.


Note: Python2 is not supported, the EOL of this version announced here. In order to use our kits, please migrate to Pyhton3. Thank you!


$ # Test the Python install
$ python --version
$ Python 3.7.2
$
$ # install Virtualenv using PIP
$ pip install virtualenv


Build from sources


Note: The production setup (PostgreSQL Database) require requirements.txt for modules installation. For local (SQLite DB) please use requirements-sqlite.txt.


$ # 1. Get the code
$ git clone https://github.com/app-generator/flask-boilerplate-dashboard-argon.git
$ cd flask-boilerplate-dashboard-argon
$
$ # install modules using a virtualenv
$ virtualenv --no-site-packages env
$ source env/bin/activate
$ 
$ # 2. Install requirements
$ # SQLIte version (no PostgreSQL)
$ pip install -r requirements-sqlite.txt
$ 
$ # OR with PostgreSQL connector
$ pip install -r requirements.txt
$
$ # 3. 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"
$
$ # 4. Run the application
$ flask run --host=0.0.0.0
$
$ # 5. Go to http://127.0.0.1:5000/, create an account and log in


Project Structure


The boilerplate code is built with a modular structure that follows the recommended pattern used by many open-source projects. The most important files / directories are listed bellow:


< ROOT > - Flask Dashboard Argon  # application root folder
    |
    |--- app/__init__.py          # application constructor  
    |--- app/base/                # base blueprint
    |--- app/home/                # home blueprint
    |
    |--- .env                     # store env variables
    |--- config.py                # app configuration profiles: Debug, Production
    |
    |--- requirements.txt         # Requirements for production PostgreSQL BDMS
    |--- requirements-sqlite.txt  # Requirements for development - SQLite storage
    |
    |--- run.py                   # bootstrap the app
    |
    |-----------------------------


Support



Resources