Skip to content

Commit 3a083bb

Browse files
committed
Expand introduction and add sequence diagram for Django in documentation
Added further explanation to the introduction of Django and Django Rest Framework and improved the wording for clarity. Additionally, a sequence diagram has been included to visually explain the flow of information in Django.
1 parent 9ca940e commit 3a083bb

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

docs/index.md

+18-4
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,24 @@ Requirements list:
2525
To start, we first need to understand what Django is. Django is the most popular web framework in the Python ecosystem, characterized by its high-level structure that encourages rapid development and clean, pragmatic design. It has been constructed by experienced developers and aims to mitigate the hassles of web development; this allows developers to focus their attention on writing their app without feeling the need to reinvent the wheel. Django is a free and open-source framework that is ingrained in the model-template-views architectural pattern. Its maintenance is overseen by the Django Software Foundation, an independent, non-profit organization based in the United States.
2626

2727
### [Django Rest Framework](https://www.django-rest-framework.org/)
28-
The Django Rest Framework is a powerful library constructed on top of Django, with a unique interlinking to the Django Model. This relationship endows Django with the enhanced ability to create application programming interfaces (APIs).
29-
30-
- 💡 Purpose: Setting the stage and objectives for the tutorial.
31-
28+
The Django Rest Framework is a powerful library constructed on top of Django, with a unique interlinking to the Django Model. This relationship endows Django with the enhanced ability to create APIs(application programming interfaces).
29+
30+
An important thing to know about Django is how the information usually flows
31+
32+
```mermaid
33+
sequenceDiagram
34+
participant B as Browser
35+
participant DS as Django Server
36+
participant UP as URL Patterns
37+
participant V as View
38+
39+
B->>DS: Sends HTTP request
40+
DS->>UP: Matches HTTP request to URL patterns
41+
UP->>V: Calls appropriate View with request object
42+
V-->>UP: Response object
43+
UP-->>DS: Returns HTTP response
44+
DS-->>B: JSON response(in our case)
45+
```
3246
## Django Models
3347

3448
- 🎬 Lecture : Fundamentals of Django models.

0 commit comments

Comments
 (0)