https://github.com/app-generator/flask-dashboard-modular-admin
Flask Dashboard - Modular Admin Design | AppSeed
https://github.com/app-generator/flask-dashboard-modular-admin
admin-dashboard appseed flask-dashboard open-source web-app-generator
Last synced: 3 months ago
JSON representation
Flask Dashboard - Modular Admin Design | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/flask-dashboard-modular-admin
- Owner: app-generator
- License: mit
- Created: 2019-11-01T11:10:56.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-04T15:01:41.000Z (over 1 year ago)
- Last Synced: 2025-03-11T05:55:50.465Z (4 months ago)
- Topics: admin-dashboard, appseed, flask-dashboard, open-source, web-app-generator
- Language: CSS
- Homepage: https://appseed.us/admin-dashboards/flask
- Size: 1.83 MB
- Stars: 60
- Watchers: 4
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Flask Dashboard](https://appseed.us/admin-dashboards/flask?ref=gh) Modular Admin
Open-source **[Flask Dashboard](https://appseed.us/admin-dashboards/flask/)** generated by `AppSeed` on top of a modern design. **ModularAdmin** is an open-source dashboard theme built in a modular way. That makes it extremely easy to scale, modify, and maintain - Design provided by ModularCode.
> Features
- DBMS: SQLite, PostgreSQL (production)
- DB Tools: SQLAlchemy ORM, Alembic (schema migrations)
- Modular design with **Blueprints**, simple codebase
- Session-Based authentication (via **flask_login**), Forms validation
- Deployment scripts: Docker, Gunicorn / Nginx, Heroku
- Support via **Github** and [Discord](https://discord.gg/fZC6hup).
> Links
- [Flask Modular Admin](https://appseed.us/admin-dashboards/flask-dashboard-modular-admin) - Product page
- [Flask Modular Admin Demo](https://flask-dashboard-modular-admin.appseed.us/login.html) - LIVE App
- [Flask Tutorial](https://github.com/app-generator/tutorial-flask) - Getting started with Flask
## Want more? Go PRO!
PRO versions include **Premium UI Kits**, Lifetime updates and **24/7 LIVE Support** (via [Discord](https://discord.gg/fZC6hup))
| [Flask Datta PRO](https://appseed.us/admin-dashboards/flask-dashboard-dattaable-pro) | [Flask Soft PRO](https://appseed.us/product/flask-soft-ui-dashboard-pro) | [Flask Volt PRO](https://appseed.us/admin-dashboards/flask-dashboard-volt-pro) |
| --- | --- | --- |
| [](https://appseed.us/admin-dashboards/flask-dashboard-dattaable-pro) | [](https://appseed.us/product/flask-soft-ui-dashboard-pro) | [](https://appseed.us/admin-dashboards/flask-dashboard-volt-pro)
## Build from sources
```bash
$ # Clone the sources
$ git clone https://github.com/app-generator/flask-dashboard-modular-admin.git
$ cd flask-dashboard-modular-admin
$
$ # Virtualenv modules installation (Unix based systems)
$ virtualenv env
$ source env/bin/activate
$
$ # Virtualenv modules installation (Windows based systems)
$ # virtualenv env
$ # .\env\Scripts\activate.bat
$
$ # 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](https://www.docker.com/), [Gunicorn](https://gunicorn.org/), and [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/).
### [Docker](https://www.docker.com/) execution
---
The application can be easily executed in a docker container. The steps:
> Get the code
```bash
$ git clone https://github.com/app-generator/flask-dashboard-modular-admin.git
$ cd flask-dashboard-modular-admin
```
> Start the app in Docker
```bash
$ 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](https://gunicorn.org/)
---
Gunicorn 'Green Unicorn' is a Python WSGI HTTP Server for UNIX.
> Install using pip
```bash
$ pip install gunicorn
```
> Start the app using gunicorn binary
```bash
$ 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](https://docs.pylonsproject.org/projects/waitress/en/stable/)
---
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
```bash
$ pip install waitress
```
> Start the app using [waitress-serve](https://docs.pylonsproject.org/projects/waitress/en/stable/runner.html)
```bash
$ 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](https://www.palletsprojects.com/p/flask/)
[Flask](/what-is/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](https://en.wikipedia.org/wiki/Dashboard_(business))
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](https://www.creative-tim.com/blog/web-design/free-dashboard-templates/?ref=appseed)*.
### [Modular Admin](https://github.com/modularcode/modular-admin-html)
ModularAdmin - an open-source dashboard theme built in a modular way. That makes it extremely easy to scale, modify and maintain - provided by [ModularCode](https://modularcode.io/?ref=appseed).
---
[Flask Dashboard](https://appseed.us/admin-dashboards/flask?ref=gh) Modular Admin - Provided by **AppSeed [App Generator](https://appseed.us/app-generator)**.