|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+# [Flask Dashboard Black](https://appseed.us/admin-dashboards/flask-dashboard-black)
|
|
|
2
|
+
|
|
|
3
|
+**[Open-Source Admin Dashboard](https://appseed.us/admin-dashboards/flask-dashboard-black)** coded in **Flask Framework** on top of **Black Dashboard** design. **Features**:
|
|
|
4
|
+
|
|
|
5
|
+- SQLite, PostgreSQL, SQLAlchemy ORM
|
|
|
6
|
+- Alembic (DB schema migrations)
|
|
|
7
|
+- Modular design with **Blueprints**
|
|
|
8
|
+- Session-Based authentication (via **flask_login**)
|
|
|
9
|
+- Forms validation
|
|
|
10
|
+- Deployment scripts: Docker, Gunicorn
|
|
|
11
|
+- UI Kit: **Black Dashboard** provided by **Creative-Tim**
|
|
|
12
|
+
|
|
|
13
|
+<br />
|
|
|
14
|
+
|
|
|
15
|
+
|
|
|
16
|
+
|
|
|
17
|
+<br />
|
|
|
18
|
+
|
|
|
19
|
+## How to use it
|
|
|
20
|
+
|
|
|
21
|
+```bash
|
|
|
22
|
+$ # Get the code
|
|
|
23
|
+$ git clone https://github.com/app-generator/flask-black-dashboard.git
|
|
|
24
|
+$ cd flask-black-dashboard
|
|
|
25
|
+$
|
|
|
26
|
+$ # Virtualenv modules installation (Unix based systems)
|
|
|
27
|
+$ virtualenv --no-site-packages env
|
|
|
28
|
+$ source env/bin/activate
|
|
|
29
|
+$
|
|
|
30
|
+$ # Virtualenv modules installation (Windows based systems)
|
|
|
31
|
+$ # virtualenv --no-site-packages env
|
|
|
32
|
+$ # .\env\Scripts\activate
|
|
|
33
|
+$
|
|
|
34
|
+$ # Install modules
|
|
|
35
|
+$ # SQLIte version (no PostgreSQL)
|
|
|
36
|
+$ pip3 install -r requirements-sqlite.txt
|
|
|
37
|
+$
|
|
|
38
|
+$ # OR with PostgreSQL connector
|
|
|
39
|
+$ pip install -r requirements.txt
|
|
|
40
|
+$
|
|
|
41
|
+$ # Set the FLASK_APP environment variable
|
|
|
42
|
+$ (Unix/Mac) export FLASK_APP=run.py
|
|
|
43
|
+$ (Windows) set FLASK_APP=run.py
|
|
|
44
|
+$ (Powershell) $env:FLASK_APP = ".\run.py"
|
|
|
45
|
+$
|
|
|
46
|
+$ # Set up the DEBUG environment
|
|
|
47
|
+$ # (Unix/Mac) export FLASK_ENV=development
|
|
|
48
|
+$ # (Windows) set FLASK_ENV=development
|
|
|
49
|
+$ # (Powershell) $env:FLASK_ENV = "development"
|
|
|
50
|
+$
|
|
|
51
|
+$ # Start the application (development mode)
|
|
|
52
|
+$ # --host=0.0.0.0 - expose the app on all network interfaces (default 127.0.0.1)
|
|
|
53
|
+$ # --port=5000 - specify the app port (default 5000)
|
|
|
54
|
+$ flask run --host=0.0.0.0 --port=5000
|
|
|
55
|
+$
|
|
|
56
|
+$ # Access the dashboard in browser: http://127.0.0.1:5000/
|
|
|
57
|
+```
|
|
|
58
|
+
|
|
|
59
|
+<br />
|
|
|
60
|
+
|
|
|
61
|
+## Docker execution
|
|
|
62
|
+
|
|
|
63
|
+The application can be easily excuted in a docker container. The steps:
|
|
|
64
|
+
|
|
|
65
|
+> Get the code
|
|
|
66
|
+
|
|
|
67
|
+```bash
|
|
|
68
|
+$ git clone https://github.com/app-generator/flask-material-dashboard.git
|
|
|
69
|
+$ cd flask-material-dashboard
|
|
|
70
|
+```
|
|
|
71
|
+
|
|
|
72
|
+> Start the app in Docker
|
|
|
73
|
+
|
|
|
74
|
+```bash
|
|
|
75
|
+$ sudo docker-compose pull && sudo docker-compose build && sudo docker-compose up -d
|
|
|
76
|
+```
|
|
|
77
|
+
|
|
|
78
|
+Visit `http://localhost:5000` in your browser. The app should be up & running.
|
|
|
79
|
+
|
|
|
80
|
+<br />
|
|
|
81
|
+
|
|
|
82
|
+## Want more? Go PRO!
|
|
|
83
|
+
|
|
|
84
|
+<br />
|
|
|
85
|
+
|
|
|
86
|
+| [Flask Dashboard Material](https://appseed.us/admin-dashboards/flask-dashboard-material-pro) | [Flask Dashboard Argon](https://appseed.us/admin-dashboards/flask-dashboard-argon-pro) | [Flask Dashboard Black](https://appseed.us/admin-dashboards/flask-dashboard-black-pro) |
|
|
|
87
|
+| --- | --- | --- |
|
|
|
88
|
+| [](https://appseed.us/admin-dashboards/flask-dashboard-material-pro) | [](https://appseed.us/admin-dashboards/flask-dashboard-argon-pro) | [](https://appseed.us/admin-dashboards/flask-dashboard-black-pro)
|
|
|
89
|
+
|
|
|
90
|
+<br />
|
|
|
91
|
+
|
|
|
92
|
+## Support
|
|
|
93
|
+
|
|
|
94
|
+- Free support via eMail < [support @ appseed.us](https://appseed.us/support) > and **Github** issues tracker
|
|
|
95
|
+- 24/7 Live Support via [Discord](https://discord.gg/fZC6hup) for paid plans and commercial products.
|
|
|
96
|
+
|
|
|
97
|
+<br />
|
|
|
98
|
+
|
|
|
99
|
+## Credits & Links
|
|
|
100
|
+
|
|
|
101
|
+- [Flask Dashboard Black](https://appseed.us/admin-dashboards/flask-dashboard-black) - Product page
|
|
|
102
|
+- [Flask Framework](https://www.palletsprojects.com/p/flask/) - Offcial website
|
|
|
103
|
+- [Flask Dashboard - Open-Source Boilerplates](https://dev.to/sm0ke/flask-dashboard-open-source-boilerplates-dkg) - A popular article published on Dev.to platform
|
|
|
104
|
+- [Flask Dashboard](https://admin-dashboards.com/tags/flask-dashboard) - Index provided by **Admin-Dashboards.com**
|
|
|
105
|
+
|
|
|
106
|
+<br />
|
|
|
107
|
+
|
|
|
108
|
+## License
|
|
|
109
|
+
|
|
|
110
|
+@MIT
|
|
|
111
|
+
|
|
|
112
|
+<br />
|
|
|
113
|
+
|
|
|
114
|
+---
|
|
|
115
|
+[Flask Dashboard Black](https://appseed.us/admin-dashboards/flask-dashboard-black) - provided by **AppSeed**
|
