Skip to content

Commit 120f37b

Browse files
Updated README
1 parent e3ee4bb commit 120f37b

File tree

1 file changed

+11
-18
lines changed

1 file changed

+11
-18
lines changed

README.md

+11-18
Original file line numberDiff line numberDiff line change
@@ -14,27 +14,25 @@ This is an email client that makes API calls to send and receive emails built us
1414
- [Note](#note)
1515
- [Copyright and License](#copyright-and-license)
1616

17-
18-
### Prerequisites
17+
## Prerequisites
1918

2019
Install the following prerequisites:
2120

2221
1. [Python 3.8-3.11](https://www.python.org/downloads/)
2322
<br> This project uses **Django v4.2.4**. For Django to work, you must install a correct version of Python on your machine. More information [here](https://django.readthedocs.io/en/stable/faq/install.html).
2423
2. [Visual Studio Code](https://code.visualstudio.com/download)
2524

25+
## Installation
2626

27-
### Installation
28-
29-
#### 1. Create a virtual environment
27+
### 1. Create a virtual environment
3028

3129
From the **root** directory, run:
3230

3331
```bash
3432
python -m venv venv
3533
```
3634

37-
#### 2. Activate the virtual environment
35+
### 2. Activate the virtual environment
3836

3937
From the **root** directory, run:
4038

@@ -50,15 +48,15 @@ On Windows:
5048
venv\scripts\activate
5149
```
5250

53-
#### 3. Install required dependencies
51+
### 3. Install required dependencies
5452

5553
From the **root** directory, run:
5654

5755
```bash
5856
pip install -r requirements.txt
5957
```
6058

61-
#### 4. Run migrations
59+
### 4. Run migrations
6260

6361
From the **root** directory, run:
6462

@@ -69,17 +67,15 @@ python manage.py makemigrations
6967
python manage.py migrate
7068
```
7169

72-
73-
### Run the application
70+
## Run the application
7471

7572
From the **root** directory, run:
7673

7774
```bash
7875
python manage.py runserver
7976
```
8077

81-
82-
### Run the tests
78+
## Run the tests
8379

8480
From the **root** directory, run:
8581

@@ -88,17 +84,14 @@ python manage.py test --pattern="tests.py"
8884

8985
```
9086

91-
92-
### View the application
87+
## View the application
9388

9489
Go to http://127.0.0.1:8000/ to view the application.
9590

96-
97-
### Note
91+
## Note
9892

9993
Just remember to send an email to an email address that already exists in the database.
10094

101-
102-
### Copyright and License
95+
## Copyright and License
10396

10497
Copyright © 2022 Bob's Programming Academy. Code released under the MIT license.

0 commit comments

Comments
 (0)