Skip to content

Commit 55e0073

Browse files
Update README.md
1 parent 8cfcb22 commit 55e0073

File tree

1 file changed

+6
-71
lines changed

1 file changed

+6
-71
lines changed

README.md

Lines changed: 6 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,17 @@
1-
# [CoreUI](https://appseed.us/generator/coreui/) Flask
1+
# [CoreUI Flask](https://appseed.us/product/coreui/flask/)
22

33
Open-source **Flask Dashboard** generated by `AppSeed` op top of an iconic design. For newcomers, **[CoreUI](https://appseed.us/generator/coreui/)** is one of the best open-source admin dashboard & control panel theme. Built on top of Bootstrap, `CoreUI` provides a range of responsive, reusable, and commonly used components.
44

55
- 👉 [CoreUI Flask](https://appseed.us/product/coreui/flask/) - product page
66
- 👉 [CoreUI Flask](https://flask-coreui.appseed-srv1.com/) - LIVE Deployment
77
- 👉 [Complete documentation](https://docs.appseed.us/products/flask-dashboards/coreui) - `Learn how to use and update the product`
8-
-[Set up the environment](https://docs.appseed.us/products/flask-dashboards/coreui#environment)
9-
-[Manage App users](https://docs.appseed.us/products/flask-dashboards/coreui#manage-app-users)
10-
-[Application Bootstrap Flow](https://docs.appseed.us/products/flask-dashboards/coreui#application-bootstrap-flow)
11-
-[UI Assets and Templates](https://docs.appseed.us/products/flask-dashboards/coreui#ui-assets-and-templates)
12-
-[Set up the MySql Database](https://docs.appseed.us/products/flask-dashboards/coreui#set-up-the-mysql-database)
13-
-[Static Assets for production](https://docs.appseed.us/products/flask-dashboards/coreui#static-assets-for-production)
148

159
<br />
1610

17-
> Built with [CoreUI Generator](https://appseed.us/generator/coreui/)
18-
19-
- Timestamp: `2022-06-01 09:08`
20-
- Build ID: `6e2f2c1a-9b20-4bf8-8b7a-2d8717100cb0`
21-
- **Free [Support](https://appseed.us/support/)** (registered users) via `Email` and `Discord`
22-
23-
<br />
24-
25-
> Features
11+
> Built with [App Generator](https://appseed.us/generator/), Timestamp: `2022-06-01 09:08`
2612
2713
- `Up-to-date dependencies`
28-
- Database: `mysql`
14+
- Database: `sqlite`
2915
- `DB Tools`: SQLAlchemy ORM, Flask-Migrate (schema migrations)
3016
- Session-Based authentication (via **flask_login**), Forms validation
3117

@@ -47,72 +33,21 @@ $ cd flask-coreui
4733

4834
<br />
4935

50-
> **Step 2** - Edit `.env` and set `DEBUG=True`. This will activate the `SQLite` persistance.
51-
52-
```txt
53-
DEBUG=True
54-
```
55-
56-
<br />
57-
58-
> **Step 3** - Start the APP in `Docker`
36+
> **Step 2** - Start the APP in `Docker`
5937
6038
```bash
6139
$ docker-compose up --build
6240
```
6341

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

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

11046
## ✨ How to use it
11147

11248
> Download the code
11349
11450
```bash
115-
$ # Get the code
11651
$ git clone https://github.com/app-generator/flask-coreui.git
11752
$ cd flask-coreui
11853
```
@@ -267,4 +202,4 @@ Soft UI Dashboard is a premium Bootstrap 5 Design now available for download in
267202
<br />
268203

269204
---
270-
[CoreUI](https://appseed.us/generator/coreui/) Flask - Open-source starter generated by **[AppSeed Generator](https://appseed.us/generator/)**.
205+
[CoreUI Flask](https://appseed.us/product/coreui/flask/) - Open-source starter generated by **[AppSeed Generator](https://appseed.us/generator/)**.

0 commit comments

Comments
 (0)