Skip to content

Commit 83cdfd7

Browse files
Update README.md
1 parent 5a41e09 commit 83cdfd7

File tree

1 file changed

+10
-13
lines changed

1 file changed

+10
-13
lines changed

README.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Open-source **[Flask Dashboard](https://appseed.us/admin-dashboards/flask/)** ge
88

99
<br />
1010

11-
> Roadmap & Features
11+
## **Features**
1212

1313
| Status | Item | info |
1414
| --- | --- | --- |
@@ -26,8 +26,7 @@ Open-source **[Flask Dashboard](https://appseed.us/admin-dashboards/flask/)** ge
2626

2727
<br />
2828

29-
30-
## ✨ Start the app in Docker
29+
## ✅ Start in `Docker`
3130

3231
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
3332
@@ -48,11 +47,11 @@ Visit `http://localhost:5085` in your browser. The app should be up & running.
4847

4948
<br />
5049

51-
## Create a new `.env` file using sample `env.sample`
50+
## Create `.env` file
5251

5352
The meaning of each variable can be found below:
5453

55-
- `DEBUG`: if `True` the app runs in develoment mode
54+
- `DEBUG`: if `True` the app runs in development mode
5655
- For production value `False` should be used
5756
- `ASSETS_ROOT`: used in assets management
5857
- default value: `/static/assets`
@@ -62,7 +61,7 @@ The meaning of each variable can be found below:
6261

6362
<br />
6463

65-
## Manual Build
64+
## Manual Build
6665

6766
> 👉 Download the code
6867
@@ -144,15 +143,15 @@ At this point, the app runs at `http://127.0.0.1:5000/`.
144143

145144
<br />
146145

147-
## API Generator
146+
## API Generator
148147

149148
This module helps to generate secure APIs using `Flask-restX` via a simple workflow:
150149

151150
- Edit/add your model in `apps/models.py`
152151
- Migrate the database:
153152

154153
```bash
155-
$ flask db init # this should be executed only once
154+
$ flask db init # This should be executed only once
156155
$ flask db migrate # Generates the SQL
157156
$ flask db upgrade # Apply changes
158157
```
@@ -174,7 +173,7 @@ The API is secured using the JWT tocken provided by `/login/jwt/` request (usern
174173
- [Books API](./media/api-books.postman_collection) - that uses PORT **5000* for the api
175174
- [Books API 2](./media/api-books-docker.postman_collection) - that uses PORT **5085* for the api (default port in Docker)
176175

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.
178177

179178
<br />
180179

@@ -190,7 +189,7 @@ By default, the app redirects guest users to authenticate. In order to access th
190189

191190
<br />
192191

193-
## ✨ Code-base structure
192+
## ✅ Codebase
194193

195194
The project is coded using blueprints, app factory pattern, dual configuration profile (development and production) and an intuitive structure presented bellow:
196195

@@ -243,7 +242,7 @@ The project is coded using blueprints, app factory pattern, dual configuration p
243242

244243
<br />
245244

246-
## [Flask Soft Dashboard](https://appseed.us/product/soft-ui-dashboard-pro/flask/) `PRO`
245+
## [Flask Soft Dashboard](https://appseed.us/product/soft-ui-dashboard-pro/flask/) `PRO`
247246

248247
> For more components, pages and priority on support, feel free to take a look at this starter:
249248
@@ -253,8 +252,6 @@ Soft UI Dashboard is a premium [Bootstrap 5](https://www.admin-dashboards.com/bo
253252
-`Enhanced UI` - more pages and components
254253
-`Priority` on support
255254

256-
<br >
257-
258255
![Soft UI Dashboard PRO - Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/170829870-8acde5af-849a-4878-b833-3be7e67cff2d.png)
259256

260257
<br />

0 commit comments

Comments
 (0)