Skip to content

Latest commit

 

History

History
181 lines (123 loc) · 7.11 KB

README.md

File metadata and controls

181 lines (123 loc) · 7.11 KB
Raw

Flask Dashboard Adminator

Open-Source Admin Dashboard coded in Flask Framework on top of Adminator Dashboard design (free version) - Provided by AppSeed Web App Generator.


Feedback/Suggest Feature

This product is built based on community feedback. Feel free (anonymously) to suggest/vote features. For more information, please access the Facebook page or chat with us on Discord.


Dashboard Features

  • UI-Ready, SQLite database
  • SQLAlchemy ORM
  • Session-Based authentication flow (login, register)
  • Forms validation
  • UI Kit: Adminator Dashboard (Free version) provided by ColorLib
  • MIT License
  • Support: Free support via Github and (Paid) 24/7 LIVE Support via Discord

Dashboard Links


Want more? Go PRO!

PRO versions include Premium UI Kits, Lifetime updates and 24/7 LIVE Support (via Discord)

Premium Flask Dashboards Flask Dashboard Dashkit PRO Flask Dashboard Black PRO
Premium Flask Dashboards - Provided by AppSeed. Flask Dashboard Dashkit PRO Flask Dashboard Black PRO


Flask Dashboard Adminator - Open-Source Flask Dashboard.


Build from sources

$ # Clone the sources
$ git clone https://github.com/app-generator/flask-dashboard-adminator.git
$ cd flask-dashboard-adminator
$
$ # Virtualenv modules installation (Unix based systems)
$ virtualenv --no-site-packages env
$ source env/bin/activate
$
$ # Virtualenv modules installation (Windows based systems)
$ # virtualenv --no-site-packages env
$ # .\env\Scripts\activate
$ 
$ # Install requirements
$ pip3 install -r requirements.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"
$
$ # Run the application
$ # --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 app in browser: http://127.0.0.1:5000/

Deployment

The app is provided with a basic configuration to be executed in Docker, Gunicorn, and Waitress.


Docker execution

The application can be easily executed in a docker container. The steps:

Get the code

$ git clone https://github.com/app-generator/flask-dashboard-adminator.git
$ cd flask-dashboard-adminator

Start the app in Docker

$ sudo docker-compose pull && sudo docker-compose build && sudo docker-compose up -d

Visit http://localhost:5005 in your browser. The app should be up & running.


Gunicorn

Gunicorn 'Green Unicorn' is a Python WSGI HTTP Server for UNIX.

Install using pip

$ pip install gunicorn

Start the app using gunicorn binary

$ gunicorn --bind 0.0.0.0:8001 run:app
Serving on http://localhost:8001

Visit http://localhost:8001 in your browser. The app should be up & running.


Waitress

Waitress (Gunicorn equivalent for Windows) is meant to be a production-quality pure-Python WSGI server with very acceptable performance. It has no dependencies except ones that live in the Python standard library.

Install using pip

$ pip install waitress

Start the app using waitress-serve

$ waitress-serve --port=8001 run:app
Serving on http://localhost:8001

Visit http://localhost:8001 in your browser. The app should be up & running.


Credits & Links


Flask Framework

Flask is a micro web framework written in Python. It is classified as a microframework because it does not require particular tools or libraries. It has no database abstraction layer, form validation, or any other components where pre-existing third-party libraries provide common functions.


What is a dashboard

A dashboard is a set of pages that are easy to read and offer information to the user in real-time regarding his business. A dashboard usually consists of graphical representations of the current status and trends within an organization. Having a well-designed dashboard will give you the possibility to act and make informed decisions based on the data that your business provides - definition provided by Creative-Tim - Free Dashboard Templates.


Adminator Dashboard

Adminator is a responsive Bootstrap 4 Admin Template. It provides you with a collection of ready to use code snippets and utilities, custom pages, a collection of applications and some useful widgets. Adminator is licensed under The MIT License (MIT) by ColorLib agency.


Flask Dashboard Adminator provided by AppSeed