Skip to content

Commit b1b3a69

Browse files
Update README.md
1 parent 9e8692b commit b1b3a69

File tree

1 file changed

+7
-83
lines changed

1 file changed

+7
-83
lines changed

README.md

Lines changed: 7 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,21 @@ Open-source **Flask Dashboard** generated by `AppSeed` op top of a modern design
44

55
- 👉 [Soft UI Dashboard Flask](https://appseed.us/product/soft-ui-dashboard/flask/) - Product page
66
- 👉 [Soft UI Dashboard Flask](https://flask-soft-ui-dashboard.appseed-srv1.com/) - LIVE Demo
7+
- 🚀 Free [Support](https://appseed.us/support/) via `Email` & `Discord`
78

89
<br />
910

1011
> Roadmap & Features
1112
1213
| Status | Item | info |
1314
| --- | --- | --- |
14-
|| **Up-to-date Dependencies** | Tested with Django `v3.2.x`, `v4.x` |
15+
|| **Up-to-date Dependencies** | |
1516
|| **UI Kit** | `Bootstrap 5`, `Dark-Mode` (persistent) |
16-
|| **Deployment** | `Docker`, [HEROKU](#deploy-app-with-heroku) |
1717
|| **Persistence** | `SQLite`, `MySql` |
1818
|| **Authentication** | Basic, `OAuth` via **AllAuth** for Github |
1919
|| **[API Generator](#api-generator)** | Secure API via `Flask-restX` |
20-
|| **Dynamic DataTables** | `Server-side` pagination, `Search`, Export |
21-
|| **Stripe Payments** | `One-Time` and `Subscriptions` |
22-
|| **Async Tasks** | via `Celery` |
23-
24-
25-
> Something is missing? Submit a new `product feature request` using the [issues tracker](https://github.com/app-generator/flask-soft-ui-dashboard/issues).
20+
|| **Deployment** | `Docker`, Page Compression |
21+
| 🚀 | **CI/CD** | via `Render` |
2622

2723
<br />
2824

@@ -33,7 +29,7 @@ Open-source **Flask Dashboard** generated by `AppSeed` op top of a modern design
3329

3430
## ✨ Start the app in Docker
3531

36-
> **Step 1** - Download the code from the GH repository (using `GIT`)
32+
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
3733
3834
```bash
3935
$ git clone https://github.com/app-generator/flask-soft-ui-dashboard.git
@@ -42,7 +38,7 @@ $ cd flask-soft-ui-dashboard
4238

4339
<br />
4440

45-
> **Step 2** - Start the APP in `Docker`
41+
> 👉 **Step 2** - Start the APP in `Docker`
4642
4743
```bash
4844
$ docker-compose up --build
@@ -68,7 +64,7 @@ The meaning of each variable can be found below:
6864

6965
## ✨ Manual Build
7066

71-
> Download the code
67+
> 👉 Download the code
7268
7369
```bash
7470
$ git clone https://github.com/app-generator/flask-soft-ui-dashboard.git
@@ -247,78 +243,6 @@ The project is coded using blueprints, app factory pattern, dual configuration p
247243

248244
<br />
249245

250-
## Deploy APP with HEROKU
251-
252-
> The set up
253-
254-
- [Create a FREE account](https://signup.heroku.com/) on Heroku platform
255-
- [Install the Heroku CLI](https://devcenter.heroku.com/articles/getting-started-with-python#set-up) that match your OS: Mac, Unix or Windows
256-
- Open a terminal window and authenticate via `heroku login` command
257-
- Clone the sources and push the project for LIVE deployment
258-
259-
<br />
260-
261-
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
262-
263-
```bash
264-
$ git clone https://github.com/app-generator/flask-soft-ui-dashboard.git
265-
$ cd flask-soft-ui-dashboard
266-
```
267-
268-
<br />
269-
270-
> 👉 **Step 2** - Connect to `HEROKU` using the console
271-
272-
```bash
273-
$ # This will open a browser window - click the login button (in browser)
274-
$ heroku login
275-
```
276-
<br />
277-
278-
> 👉 **Step 3** - Create the `HEROKU` project
279-
280-
```bash
281-
$ heroku create
282-
```
283-
284-
<br />
285-
286-
> 👉 **Step 4** - Access the HEROKU dashboard and update the environment variables. This step is mandatory because HEROKU ignores the `.env`.
287-
288-
- `DEBUG`=True
289-
- `FLASK_APP`=run.py
290-
- `ASSETS_ROOT`=/static/assets
291-
292-
![AppSeed - HEROKU Set UP](https://user-images.githubusercontent.com/51070104/171815176-c1ca7681-38cc-4edf-9ecc-45f93621573d.jpg)
293-
294-
<br />
295-
296-
> 👉 **Step 5** - Push Sources to `HEROKU`
297-
298-
```bash
299-
$ git push heroku HEAD:master
300-
```
301-
302-
<br />
303-
304-
> 👉 **Step 6** - Visit the app in the browser
305-
306-
```bash
307-
$ heroku open
308-
```
309-
310-
At this point, the APP should be up & running.
311-
312-
<br />
313-
314-
> 👉 **Step 7** (Optional) - Visualize `HEROKU` logs
315-
316-
```bash
317-
$ heroku logs --tail
318-
```
319-
320-
<br />
321-
322246
## PRO Version
323247

324248
> For more components, pages and priority on support, feel free to take a look at this amazing starter:

0 commit comments

Comments
 (0)