Skip to content
This repository was archived by the owner on Jun 1, 2022. It is now read-only.

Commit 4332ab6

Browse files
committed
Update readme to include mermaid diagram
1 parent dfc1b6f commit 4332ab6

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

Diff for: README.md

+24
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
<li><a href="#data">Data</a></li>
2323
</ul>
2424
</li>
25+
<li><a href="#example-request">Example request</a></li>
2526
</ol>
2627
</details>
2728

@@ -189,3 +190,26 @@ The Azure Connection String will be the location of the Blob store where the CDN
189190
```txt
190191
DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1;QueueEndpoint=http://127.0.0.1:10001/devstoreaccount1;
191192
```
193+
194+
## Example request
195+
196+
Below depicates a sequence diagram of the steps involved for navigating to and loading content from the dev blog. The diagram neglects to illustrate the role of Internet Service Providers, Domain Name Servers, and Internet registrars, however it simply visualises a typical workflow through the web application.
197+
198+
```mermaid
199+
sequenceDiagram
200+
actor U as User
201+
participant B as Browser
202+
participant WS as Django
203+
participant DB as PostgreSQL
204+
participant CDN as Azure CDN
205+
U->>+B: Navigate to dev
206+
Note over U,B: blogkylejuliandevblog.herokuapp.com
207+
B->>+WS: Request web page
208+
WS->>+DB: Request articles
209+
DB->>-WS: Return paginated articles
210+
WS->>-B: Generate html content
211+
B->>+CDN: Get static resources
212+
Note over B,CDN: Javascript, CSS, and image files
213+
CDN->>-B: Return static resources
214+
B->>-U: Show rendered web page
215+
```

0 commit comments

Comments
 (0)