|
|
@@ -11,6 +11,7 @@ Open-source **Flask Dashboard** generated by `AppSeed` op top of a modern `Boots
|
|
|
> 🚀 Built with [App Generator](https://appseed.us/generator/), timestamp: `2022-05-25 09:44`
|
|
|
|
|
|
- `Up-to-date dependencies`, active versioning
|
|
|
+- [Black Dashboard](https://www.creative-tim.com/product/black-dashboard?AFFILIATE=128200) Design by `Creative-Tim`
|
|
|
- `DB Tools`: SQLAlchemy ORM, `Flask-Migrate` (schema migrations)
|
|
|
- `Persistence`:
|
|
|
- `SQLite` for development - `DEBUG=True` in `.env`
|
|
|
@@ -19,7 +20,7 @@ Open-source **Flask Dashboard** generated by `AppSeed` op top of a modern `Boots
|
|
|
- Session Based (via **flask_login**)
|
|
|
- `Social Login` (optional) for **Github**
|
|
|
- `Deployment`
|
|
|
- - `Docker`, HEROKU
|
|
|
+ - `Docker`
|
|
|
- Page Compression via `Flask-Minify` (for production)
|
|
|
- `Dark Mode` (enhancement)
|
|
|
- Persistent via browser `local storage`
|
|
|
@@ -32,7 +33,7 @@ Open-source **Flask Dashboard** generated by `AppSeed` op top of a modern `Boots
|
|
|
|
|
|
## ✨ Start the app in Docker
|
|
|
|
|
|
-> **Step 1** - Download the code from the GH repository (using `GIT`)
|
|
|
+> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
|
|
|
|
|
|
```bash
|
|
|
$ git clone https://github.com/app-generator/flask-black-dashboard.git
|
|
|
@@ -41,7 +42,7 @@ $ cd flask-black-dashboard
|
|
|
|
|
|
<br />
|
|
|
|
|
|
-> **Step 2** - Start the APP in `Docker`
|
|
|
+> 👉 **Step 2** - Start the APP in `Docker`
|
|
|
|
|
|
```bash
|
|
|
$ docker-compose up --build
|
|
|
@@ -255,78 +256,6 @@ The project is coded using blueprints, app factory pattern, dual configuration p
|
|
|
|
|
|
<br />
|
|
|
|
|
|
-## ✨ Deploy APP with HEROKU
|
|
|
-
|
|
|
-> The set up
|
|
|
-
|
|
|
-- [Create a FREE account](https://signup.heroku.com/) on Heroku platform
|
|
|
-- [Install the Heroku CLI](https://devcenter.heroku.com/articles/getting-started-with-python#set-up) that match your OS: Mac, Unix or Windows
|
|
|
-- Open a terminal window and authenticate via `heroku login` command
|
|
|
-- Clone the sources and push the project for LIVE deployment
|
|
|
-
|
|
|
-<br />
|
|
|
-
|
|
|
-> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
|
|
|
-
|
|
|
-```bash
|
|
|
-$ git clone https://github.com/app-generator/flask-black-dashboard.git
|
|
|
-$ cd flask-black-dashboard
|
|
|
-```
|
|
|
-
|
|
|
-<br />
|
|
|
-
|
|
|
-> 👉 **Step 2** - Connect to `HEROKU` using the console
|
|
|
-
|
|
|
-```bash
|
|
|
-$ # This will open a browser window - click the login button (in browser)
|
|
|
-$ heroku login
|
|
|
-```
|
|
|
-<br />
|
|
|
-
|
|
|
-> 👉 **Step 3** - Create the `HEROKU` project
|
|
|
-
|
|
|
-```bash
|
|
|
-$ heroku create
|
|
|
-```
|
|
|
-
|
|
|
-<br />
|
|
|
-
|
|
|
-> 👉 **Step 4** - Access the HEROKU dashboard and update the environment variables. This step is mandatory because HEROKU ignores the `.env`.
|
|
|
-
|
|
|
-- `DEBUG`=True
|
|
|
-- `FLASK_APP`=run.py
|
|
|
-- `ASSETS_ROOT`=/static/assets
|
|
|
-
|
|
|
-
|
|
|
-
|
|
|
-<br />
|
|
|
-
|
|
|
-> 👉 **Step 5** - Push Sources to `HEROKU`
|
|
|
-
|
|
|
-```bash
|
|
|
-$ git push heroku HEAD:master
|
|
|
-```
|
|
|
-
|
|
|
-<br />
|
|
|
-
|
|
|
-> 👉 **Step 6** - Visit the app in the browser
|
|
|
-
|
|
|
-```bash
|
|
|
-$ heroku open
|
|
|
-```
|
|
|
-
|
|
|
-At this point, the APP should be up & running.
|
|
|
-
|
|
|
-<br />
|
|
|
-
|
|
|
-> 👉 **Step 7** (Optional) - Visualize `HEROKU` logs
|
|
|
-
|
|
|
-```bash
|
|
|
-$ heroku logs --tail
|
|
|
-```
|
|
|
-
|
|
|
-<br />
|
|
|
-
|
|
|
## PRO Version
|
|
|
|
|
|
> For more components, pages and priority on support, feel free to take a look at this amazing starter:
|
|
|
@@ -344,4 +273,4 @@ Black Dashboard is a premium Bootstrap Design now available for download in Djan
|
|
|
<br />
|
|
|
|
|
|
---
|
|
|
-[Black Dashboard Flask](https://appseed.us/product/black-dashboard/flask/) - Open-source starter generated by **[AppSeed Generator](https://appseed.us/generator/)**.
|
|
|
+[Black Dashboard Flask](https://appseed.us/product/black-dashboard/flask/) - Open-source starter generated by **[App Generator](https://appseed.us/generator/)**.
|