Skip to content

Commit 71ac3ad

Browse files
Update README.md
1 parent 8202dc4 commit 71ac3ad

File tree

1 file changed

+8
-69
lines changed

1 file changed

+8
-69
lines changed

README.md

Lines changed: 8 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,111 +1,52 @@
1-
# [Gradient Able](https://appseed.us/generator/gradient-able/) Flask
1+
# [Gradient Able Flask](https://appseed.us/product/gradient-able/flask/)
22

3-
Open-source **Flask Dashboard** generated by `AppSeed` op top of a modern design. **[Gradient Able](https://appseed.us/generator/gradient-able/)** Bootstrap Lite is the most stylised Bootstrap 4 Lite Admin Template, around all other Lite/Free admin templates in the market. It comes with high feature-rich pages and components with fully developer-centric code. Before developing Gradient Able our key points were performance and design.
4-
5-
<br />
6-
7-
> Built with [Gradient Able Generator](https://appseed.us/generator/gradient-able/), timestamp: `2022-06-09 09:13`
3+
Open-source **Flask Dashboard** generated by `AppSeed` op top of a modern design. **[Gradient Able](https://appseed.us/product/gradient-able/flask/)** Bootstrap Lite is the most stylised Bootstrap 5 Admin Template, around all other Lite/Free admin templates in the market. It comes with high feature-rich pages and components with fully developer-centric code. Before developing Gradient Able our key points were performance and design.
84

95
- 👉 [Gradient Able Flask](https://appseed.us/product/gradient-able/flask/) - Product page
106
- 👉 [Gradient Able Flask](https://flask-gradient-able.appseed-srv1.com/) - LIVE deployment
117
- 👉 [Complete documentation](https://docs.appseed.us/products/flask-dashboards/gradient-able) - `Learn how to use and update the product`
12-
- 👉 **Free [Support](https://appseed.us/support/)** (registered users) via `Email` and `Discord`
13-
-[PRO Version Available](#pro-version) - `enhanced UI` and more `features`
148

159
<br />
1610

17-
> Features
11+
> 🚀 Built with [App Generator](https://appseed.us/generator/), timestamp: `2022-06-09 09:13`
1812
1913
- `Up-to-date dependencies`
20-
- Database: `mysql`
14+
- Database: `sqlite`
2115
- `DB Tools`: SQLAlchemy ORM, Flask-Migrate (schema migrations)
2216
- Session-Based authentication (via **flask_login**), Forms validation
2317

2418
<br />
2519

2620
![Gradient Able - Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/171583187-c4ca1bef-b535-458e-9250-8d62ba1f5b30.png)
2721

28-
<br />
29-
22+
<br />
3023

3124
## ✨ Start the app in Docker
3225

3326
> **Step 1** - Download the code from the GH repository (using `GIT`)
3427
3528
```bash
36-
$ # Get the code
3729
$ git clone https://github.com/app-generator/flask-gradient-able.git
3830
$ cd flask-gradient-able
3931
```
4032

4133
<br />
4234

43-
> **Step 2** - Edit `.env` and set `DEBUG=True`. This will activate the `SQLite` persistance.
44-
45-
```txt
46-
DEBUG=True
47-
```
48-
49-
<br />
50-
51-
> **Step 3** - Start the APP in `Docker`
35+
> **Step 2** - Start the APP in `Docker`
5236
5337
```bash
5438
$ docker-compose up --build
5539
```
5640

5741
Visit `http://localhost:5085` in your browser. The app should be up & running.
5842

59-
<br />
60-
61-
62-
63-
## ✨ Set up the MySql Database
64-
65-
**Note:** Make sure your Mysql server is properly installed and accessible.
66-
67-
> **Step 1** - Create the MySql Database to be used by the app
68-
69-
- `Create a new MySql` database
70-
- `Create a new user` and assign full privilegies (read/write)
71-
72-
<br />
73-
74-
> **Step 2** - Edit the `.env` to match your MySql DB credentials. Make sure `DB_ENGINE` is set to `mysql`.
75-
76-
- `DB_ENGINE` : `mysql`
77-
- `DB_NAME` : default value = `appseed_db`
78-
- `DB_HOST` : default value = `localhost`
79-
- `DB_PORT` : default value = `3306`
80-
- `DB_USERNAME`: default value = `appseed_db_usr`
81-
- `DB_PASS` : default value = `pass`
82-
83-
<br />
84-
85-
Here is a sample:
86-
87-
```txt
88-
# .env sample
89-
90-
DEBUG=False # False enables the MySql Persistence
91-
92-
DB_ENGINE=mysql # Database Driver
93-
DB_NAME=appseed_db # Database Name
94-
DB_USERNAME=appseed_db_usr # Database User
95-
DB_PASS=STRONG_PASS_HERE # Password
96-
DB_HOST=localhost # Database HOST, default is localhost
97-
DB_PORT=3306 # MySql port, default = 3306
98-
```
99-
100-
<br />
101-
43+
<br />
10244

10345
## ✨ How to use it
10446

10547
> Download the code
10648
10749
```bash
108-
$ # Get the code
10950
$ git clone https://github.com/app-generator/flask-gradient-able.git
11051
$ cd flask-gradient-able
11152
```
@@ -244,8 +185,6 @@ The project is coded using blueprints, app factory pattern, dual configuration p
244185

245186
<br />
246187

247-
248-
249188
## PRO Version
250189

251190
> For more components, pages and priority on support, feel free to take a look at this amazing starter:
@@ -262,4 +201,4 @@ Designed for those who like bold elements and beautiful websites, **Gradient Abl
262201
<br />
263202

264203
---
265-
[Gradient Able](https://appseed.us/generator/gradient-able/) Flask - Open-source starter generated by **[AppSeed Generator](https://appseed.us/generator/)**.
204+
[Gradient Able Flask](https://appseed.us/product/gradient-able/flask/) - Open-source starter generated by **[AppSeed Generator](https://appseed.us/generator/)**.

0 commit comments

Comments
 (0)