You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-13Lines changed: 10 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Open-source **[Flask Dashboard](https://appseed.us/admin-dashboards/flask/)** ge
8
8
9
9
<br />
10
10
11
-
> Roadmap & Features
11
+
## ✅ **Features**
12
12
13
13
| Status | Item | info |
14
14
| --- | --- | --- |
@@ -26,8 +26,7 @@ Open-source **[Flask Dashboard](https://appseed.us/admin-dashboards/flask/)** ge
26
26
27
27
<br />
28
28
29
-
30
-
## ✨ Start the app in Docker
29
+
## ✅ Start in `Docker`
31
30
32
31
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
33
32
@@ -48,11 +47,11 @@ Visit `http://localhost:5085` in your browser. The app should be up & running.
48
47
49
48
<br />
50
49
51
-
## ✨ Create a new `.env` file using sample `env.sample`
50
+
## ✅ Create `.env` file
52
51
53
52
The meaning of each variable can be found below:
54
53
55
-
-`DEBUG`: if `True` the app runs in develoment mode
54
+
-`DEBUG`: if `True` the app runs in development mode
56
55
- For production value `False` should be used
57
56
-`ASSETS_ROOT`: used in assets management
58
57
- default value: `/static/assets`
@@ -62,7 +61,7 @@ The meaning of each variable can be found below:
62
61
63
62
<br />
64
63
65
-
## ✨ Manual Build
64
+
## ✅ Manual Build
66
65
67
66
> 👉 Download the code
68
67
@@ -144,15 +143,15 @@ At this point, the app runs at `http://127.0.0.1:5000/`.
144
143
145
144
<br />
146
145
147
-
## API Generator
146
+
## ✅ API Generator
148
147
149
148
This module helps to generate secure APIs using `Flask-restX` via a simple workflow:
150
149
151
150
- Edit/add your model in `apps/models.py`
152
151
- Migrate the database:
153
152
154
153
```bash
155
-
$ flask db init #this should be executed only once
154
+
$ flask db init #This should be executed only once
156
155
$ flask db migrate # Generates the SQL
157
156
$ flask db upgrade # Apply changes
158
157
```
@@ -174,7 +173,7 @@ The API is secured using the JWT tocken provided by `/login/jwt/` request (usern
174
173
-[Books API](./media/api-books.postman_collection) - that uses PORT **5000* for the api
175
174
-[Books API 2](./media/api-books-docker.postman_collection) - that uses PORT **5085* for the api (default port in Docker)
176
175
177
-
In case both port are unusable in your environment, feel free to edit the files before POSTMAN import.
176
+
In case both ports are unusable in your environment, feel free to edit the files before POSTMAN import.
178
177
179
178
<br />
180
179
@@ -190,7 +189,7 @@ By default, the app redirects guest users to authenticate. In order to access th
190
189
191
190
<br />
192
191
193
-
## ✨ Code-base structure
192
+
## ✅ Codebase
194
193
195
194
The project is coded using blueprints, app factory pattern, dual configuration profile (development and production) and an intuitive structure presented bellow:
196
195
@@ -243,7 +242,7 @@ The project is coded using blueprints, app factory pattern, dual configuration p
> For more components, pages and priority on support, feel free to take a look at this starter:
249
248
@@ -253,8 +252,6 @@ Soft UI Dashboard is a premium [Bootstrap 5](https://www.admin-dashboards.com/bo
253
252
- ✅ `Enhanced UI` - more pages and components
254
253
- ✅ `Priority` on support
255
254
256
-
<br >
257
-
258
255

0 commit comments