Skip to content

Commit f667255

Browse files
Update README.md
1 parent 729fcc2 commit f667255

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Simple [Flask API Boilerplate](https://appseed.us/boilerplate-code/flask-api-boi
1414

1515
<br />
1616

17-
## Quick Start in `Docker`
17+
## Quick Start in `Docker`
1818

1919
> Get the code
2020
@@ -49,7 +49,7 @@ The API server will start using the PORT `5000`.
4949

5050
<br />
5151

52-
## Table of Contents
52+
## Table of Contents
5353

5454
1. [Getting Started](#getting-started)
5555
2. [Project Structure](#project-structure)
@@ -58,9 +58,9 @@ The API server will start using the PORT `5000`.
5858

5959
<br />
6060

61-
## How to use the code
61+
## How to use the code
6262

63-
**Step #1** - Clone the project
63+
> **Step #1** - Clone the project
6464
6565
```bash
6666
$ git clone https://github.com/app-generator/api-server-flask.git
@@ -69,7 +69,7 @@ $ cd api-server-flask
6969

7070
<br />
7171

72-
**Step #2** - create virtual environment using python3 and activate it (keep it outside our project directory)
72+
> **Step #2** - create virtual environment using python3 and activate it (keep it outside our project directory)
7373
7474
```bash
7575
$ # Virtualenv modules installation (Unix based systems)
@@ -83,22 +83,22 @@ $ # .\env\Scripts\activate
8383

8484
<br />
8585

86-
**Step #3** - Install dependencies in virtualenv
86+
> **Step #3** - Install dependencies in virtualenv
8787
8888
```bash
8989
$ pip install -r requirements.txt
9090
```
9191

9292
<br />
9393

94-
**Step #4** - setup `flask` command for our app
94+
> **Step #4** - setup `flask` command for our app
9595
9696
```bash
9797
$ export FLASK_APP=run.py
9898
$ export FLASK_ENV=development
9999
```
100100

101-
> Or for Windows-based systems
101+
For **Windows-based** systems
102102

103103
```powershell
104104
$ (Windows CMD) set FLASK_APP=run.py
@@ -110,7 +110,7 @@ $ (Powershell) $env:FLASK_ENV = "development"
110110

111111
<br />
112112

113-
**Step #5** - start test APIs server at `localhost:5000`
113+
> **Step #5** - start test APIs server at `localhost:5000`
114114
115115
```bash
116116
$ flask run
@@ -122,7 +122,7 @@ Use the API via `POSTMAN` or Swagger Dashboard.
122122

123123
<br />
124124

125-
## Project Structure
125+
## Project Structure
126126

127127
```bash
128128
api-server-flask/
@@ -140,7 +140,7 @@ api-server-flask/
140140

141141
<br />
142142

143-
## API
143+
## API
144144

145145
For a fast set up, use this `POSTMAN` file: [api_sample](https://github.com/app-generator/api-unified-definition/blob/main/api.postman_collection.json)
146146

@@ -187,7 +187,7 @@ authorization: JWT_TOKEN (returned by Login request)
187187

188188
<br />
189189

190-
## Testing
190+
## Testing
191191

192192
Run tests using `pytest tests.py`
193193

0 commit comments

Comments
 (0)