@@ -14,27 +14,25 @@ This is an email client that makes API calls to send and receive emails built us
14
14
- [ Note] ( #note )
15
15
- [ Copyright and License] ( #copyright-and-license )
16
16
17
-
18
- ### Prerequisites
17
+ ## Prerequisites
19
18
20
19
Install the following prerequisites:
21
20
22
21
1 . [ Python 3.8-3.11] ( https://www.python.org/downloads/ )
23
22
<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 ) .
24
23
2 . [ Visual Studio Code] ( https://code.visualstudio.com/download )
25
24
25
+ ## Installation
26
26
27
- ### Installation
28
-
29
- #### 1. Create a virtual environment
27
+ ### 1. Create a virtual environment
30
28
31
29
From the ** root** directory, run:
32
30
33
31
``` bash
34
32
python -m venv venv
35
33
```
36
34
37
- #### 2. Activate the virtual environment
35
+ ### 2. Activate the virtual environment
38
36
39
37
From the ** root** directory, run:
40
38
@@ -50,15 +48,15 @@ On Windows:
50
48
venv\s cripts\a ctivate
51
49
```
52
50
53
- #### 3. Install required dependencies
51
+ ### 3. Install required dependencies
54
52
55
53
From the ** root** directory, run:
56
54
57
55
``` bash
58
56
pip install -r requirements.txt
59
57
```
60
58
61
- #### 4. Run migrations
59
+ ### 4. Run migrations
62
60
63
61
From the ** root** directory, run:
64
62
@@ -69,17 +67,15 @@ python manage.py makemigrations
69
67
python manage.py migrate
70
68
```
71
69
72
-
73
- ### Run the application
70
+ ## Run the application
74
71
75
72
From the ** root** directory, run:
76
73
77
74
``` bash
78
75
python manage.py runserver
79
76
```
80
77
81
-
82
- ### Run the tests
78
+ ## Run the tests
83
79
84
80
From the ** root** directory, run:
85
81
@@ -88,17 +84,14 @@ python manage.py test --pattern="tests.py"
88
84
89
85
```
90
86
91
-
92
- ### View the application
87
+ ## View the application
93
88
94
89
Go to http://127.0.0.1:8000/ to view the application.
95
90
96
-
97
- ### Note
91
+ ## Note
98
92
99
93
Just remember to send an email to an email address that already exists in the database.
100
94
101
-
102
- ### Copyright and License
95
+ ## Copyright and License
103
96
104
97
Copyright © 2022 Bob's Programming Academy. Code released under the MIT license.
0 commit comments