|
1 | | -# material-dashboard-flask |
| 1 | +# [Material Dashboard Flask](https://www.creative-tim.com/product/material-dashboard-flask) [](https://twitter.com/home?status=Material%20Dashboard,%20a%20free%20Material%20Bootstrap%204%20Admin%20Template%20%E2%9D%A4%EF%B8%8F%20https%3A//bit.ly/2Lyat1Y%20%23bootstrap%20%23material%20%23design%20%23developers%20%23freebie%20%20via%20%40CreativeTim) |
| 2 | + |
| 3 | +  [](https://github.com/creativetimofficial/material-dashboard-flask/issues?q=is%3Aopen+is%3Aissue) [](https://github.com/creativetimofficial/material-dashboard-flask/issues?q=is%3Aissue+is%3Aclosed) [](https://gitter.im/creative-tim-general/Lobby) [](https://discord.gg/E4aHAQy) |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | +<br /> |
| 8 | + |
| 9 | +> Free product - **Flask Dashboard** starter project - Features: |
| 10 | +
|
| 11 | +- UI Kit: **Material Dashboard** (Free Version) |
| 12 | +- [Codebase](https://github.com/app-generator/boilerplate-code-flask-dashboard) - provided by **[AppSeed](https://appseed.us/)** |
| 13 | +- SQLite, PostgreSQL, SQLAlchemy ORM |
| 14 | +- Alembic (DB schema migrations) |
| 15 | +- Modular design with **Blueprints** |
| 16 | +- Session-Based authentication (via **flask_login**) |
| 17 | +- Forms validation |
| 18 | +- Deployment scripts: Docker, Gunicorn / Nginx, Heroku |
| 19 | + |
| 20 | +<br /> |
| 21 | + |
| 22 | +## Table of Contents |
| 23 | + |
| 24 | +* [Demo](#demo) |
| 25 | +* [Quick Start](#quick-start) |
| 26 | +* [Documentation](#documentation) |
| 27 | +* [File Structure](#file-structure) |
| 28 | +* [Browser Support](#browser-support) |
| 29 | +* [Resources](#resources) |
| 30 | +* [Reporting Issues](#reporting-issues) |
| 31 | +* [Technical Support or Questions](#technical-support-or-questions) |
| 32 | +* [Licensing](#licensing) |
| 33 | +* [Useful Links](#useful-links) |
| 34 | + |
| 35 | +<br /> |
| 36 | + |
| 37 | +## Demo |
| 38 | + |
| 39 | +> To authenticate use the default credentials ***test / pass*** or create a new user on the [registration page](https://www.creative-tim.com/live/material-dashboard-flask). |
| 40 | +
|
| 41 | +- **Material Dashboard Flask** [Login Page](https://www.creative-tim.com/live/material-dashboard-flask) |
| 42 | + |
| 43 | +<br /> |
| 44 | + |
| 45 | +## Quick start |
| 46 | + |
| 47 | +> UNZIP the sources or clone the private repository. After getting the code, open a terminal and navigate to the working directory, with product source code. |
| 48 | +
|
| 49 | +```bash |
| 50 | +$ # Get the code |
| 51 | +$ git clone https://github.com/creativetimofficial/material-dashboard-flask.git |
| 52 | +$ cd material-dashboard-flask |
| 53 | +$ |
| 54 | +$ # Virtualenv modules installation (Unix based systems) |
| 55 | +$ virtualenv env |
| 56 | +$ source env/bin/activate |
| 57 | +$ |
| 58 | +$ # Virtualenv modules installation (Windows based systems) |
| 59 | +$ # virtualenv env |
| 60 | +$ # .\env\Scripts\activate |
| 61 | +$ |
| 62 | +$ # Install modules - SQLite Database |
| 63 | +$ pip3 install -r requirements.txt |
| 64 | +$ |
| 65 | +$ # OR with PostgreSQL connector |
| 66 | +$ # pip install -r requirements-pgsql.txt |
| 67 | +$ |
| 68 | +$ # Set the FLASK_APP environment variable |
| 69 | +$ (Unix/Mac) export FLASK_APP=run.py |
| 70 | +$ (Windows) set FLASK_APP=run.py |
| 71 | +$ (Powershell) $env:FLASK_APP = ".\run.py" |
| 72 | +$ |
| 73 | +$ # Set up the DEBUG environment |
| 74 | +$ # (Unix/Mac) export FLASK_ENV=development |
| 75 | +$ # (Windows) set FLASK_ENV=development |
| 76 | +$ # (Powershell) $env:FLASK_ENV = "development" |
| 77 | +$ |
| 78 | +$ # Start the application (development mode) |
| 79 | +$ # --host=0.0.0.0 - expose the app on all network interfaces (default 127.0.0.1) |
| 80 | +$ # --port=5000 - specify the app port (default 5000) |
| 81 | +$ flask run --host=0.0.0.0 --port=5000 |
| 82 | +$ |
| 83 | +$ # Access the dashboard in browser: http://127.0.0.1:5000/ |
| 84 | +``` |
| 85 | + |
| 86 | +> Note: To use the app, please access the registration page and create a new user. After authentication, the app will unlock the private pages. |
| 87 | +
|
| 88 | +<br /> |
| 89 | + |
| 90 | +## Documentation |
| 91 | +The documentation for the **Material Dashboard Flask** is hosted at our [website](https://demos.creative-tim.com/material-dashboard-flask/docs/1.0/getting-started/getting-started-flask.html). |
| 92 | + |
| 93 | +<br /> |
| 94 | + |
| 95 | +## File Structure |
| 96 | +Within the download you'll find the following directories and files: |
| 97 | + |
| 98 | +```bash |
| 99 | +< PROJECT ROOT > |
| 100 | + | |
| 101 | + |-- app/ |
| 102 | + | |-- home/ # Home Blueprint - serve app pages (private area) |
| 103 | + | |-- base/ # Base Blueprint - handles the authentication |
| 104 | + | |-- static/ |
| 105 | + | | |-- <css, JS, images> # CSS files, Javascripts files |
| 106 | + | | |
| 107 | + | |-- templates/ # Templates used to render pages |
| 108 | + | | |
| 109 | + | |-- includes/ # |
| 110 | + | | |-- navigation.html # Top menu component |
| 111 | + | | |-- sidebar.html # Sidebar component |
| 112 | + | | |-- footer.html # App Footer |
| 113 | + | | |-- scripts.html # Scripts common to all pages |
| 114 | + | | |
| 115 | + | |-- layouts/ # Master pages |
| 116 | + | | |-- base-fullscreen.html # Used by Authentication pages |
| 117 | + | | |-- base.html # Used by common pages |
| 118 | + | | |
| 119 | + | |-- accounts/ # Authentication pages |
| 120 | + | |-- login.html # Login page |
| 121 | + | |-- register.html # Registration page |
| 122 | + | |
| 123 | + |-- requirements.txt # Development modules - SQLite storage |
| 124 | + |-- requirements-mysql.txt # Production modules - Mysql DMBS |
| 125 | + |-- requirements-pqsql.txt # Production modules - PostgreSql DMBS |
| 126 | + | |
| 127 | + |-- .env # Inject Configuration via Environment |
| 128 | + |-- config.py # Set up the app |
| 129 | + |-- run.py # Start the app - WSGI gateway |
| 130 | + | |
| 131 | + |-- ************************************************************************ |
| 132 | +``` |
| 133 | + |
| 134 | +<br /> |
| 135 | + |
| 136 | +## Browser Support |
| 137 | + |
| 138 | +At present, we officially aim to support the last two versions of the following browsers: |
| 139 | + |
| 140 | +<img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/chrome.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/firefox.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/edge.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/safari.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/opera.png" width="64" height="64"> |
| 141 | + |
| 142 | +<br /> |
| 143 | + |
| 144 | +## Resources |
| 145 | + |
| 146 | +- Demo: <https://www.creative-tim.com/live/material-dashboard-flask> |
| 147 | +- Download Page: <https://www.creative-tim.com/product/material-dashboard-flask> |
| 148 | +- Documentation: <https://demos.creative-tim.com/material-dashboard-flask/docs/1.0/getting-started/getting-started-flask.html> |
| 149 | +- License Agreement: <https://www.creative-tim.com/license> |
| 150 | +- Support: <https://www.creative-tim.com/contact-us> |
| 151 | +- Issues: [Github Issues Page](https://github.com/creativetimofficial/material-dashboard-flask/issues) |
| 152 | + |
| 153 | +<br /> |
| 154 | + |
| 155 | +## Reporting Issues |
| 156 | + |
| 157 | +We use GitHub Issues as the official bug tracker for the **Material Dashboard Flask**. Here are some advices for our users that want to report an issue: |
| 158 | + |
| 159 | +1. Make sure that you are using the latest version of the **Material Dashboard Flask**. Check the CHANGELOG from your dashboard on our [website](https://www.creative-tim.com/). |
| 160 | +2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed. |
| 161 | +3. Some issues may be browser-specific, so specifying in what browser you encountered the issue might help. |
| 162 | + |
| 163 | +<br /> |
| 164 | + |
| 165 | +## Technical Support or Questions |
| 166 | + |
| 167 | +If you have questions or need help integrating the product please [contact us](https://www.creative-tim.com/contact-us) instead of opening an issue. |
| 168 | + |
| 169 | +<br /> |
| 170 | + |
| 171 | +## Licensing |
| 172 | + |
| 173 | +- Copyright 2019 - present [Creative Tim](https://www.creative-tim.com/) |
| 174 | +- Licensed under [Creative Tim EULA](https://www.creative-tim.com/license) |
| 175 | + |
| 176 | +<br /> |
| 177 | + |
| 178 | +## Useful Links |
| 179 | + |
| 180 | +- [More products](https://www.creative-tim.com/bootstrap-themes) from Creative Tim |
| 181 | +- [Tutorials](https://www.youtube.com/channel/UCVyTG4sCw-rOvB9oHkzZD1w) |
| 182 | +- [Freebies](https://www.creative-tim.com/bootstrap-themes/free) from Creative Tim |
| 183 | +- [Affiliate Program](https://www.creative-tim.com/affiliates/new) (earn money) |
| 184 | + |
| 185 | +<br /> |
| 186 | + |
| 187 | +## Social Media |
| 188 | + |
| 189 | +- Twitter: <https://twitter.com/CreativeTim> |
| 190 | +- Facebook: <https://www.facebook.com/CreativeTim> |
| 191 | +- Dribbble: <https://dribbble.com/creativetim> |
| 192 | +- Instagram: <https://www.instagram.com/CreativeTimOfficial> |
| 193 | + |
| 194 | +<br /> |
| 195 | + |
| 196 | +--- |
| 197 | +[Material Dashboard Flask](https://www.creative-tim.com/product/material-dashboard-flask) - Provided by [Creative Tim](https://www.creative-tim.com/) and [AppSeed](https://appseed.us) |
0 commit comments