Skip to content

Commit e1e3daf

Browse files
committed
Update index page in the documentation
Replaced the previous content of the index page in the documentation with an in-depth guide on building an API using Django and Django Rest Framework, which includes estimated durations, lectures, exercises and a link to presentation slides. The new content presents a structured and comprehensive learning journey for the readers.
1 parent 367655a commit e1e3daf

File tree

1 file changed

+47
-12
lines changed

1 file changed

+47
-12
lines changed

docs/index.md

+47-12
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,52 @@
1-
# Welcome to MkDocs
1+
# 🌐 Building Your First API with Django and Django Rest Framework
22

3-
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
3+
## Summary
44

5-
## Commands
5+
- **Total Duration:** 3 hours 30 minutes
6+
- **Lecture:** 1 hour (approximately 30%)
7+
- **Exercises:** 2 hours 30 minutes (approximately 70%)
68

7-
* `mkdocs new [dir-name]` - Create a new project.
8-
* `mkdocs serve` - Start the live-reloading docs server.
9-
* `mkdocs build` - Build the documentation site.
10-
* `mkdocs -h` - Print help message and exit.
119

12-
## Project layout
10+
[Presentation slides](https://docs.google.com/presentation/d/1Ajv9MYQQ011_Y4r1W4I6Y-6XP_faFF0317Zkn2XupMw/edit?usp=sharing) 📊
1311

14-
mkdocs.yml # The configuration file.
15-
docs/
16-
index.md # The documentation homepage.
17-
... # Other markdown pages, images and other files.
12+
## Introduction and Overview
13+
14+
- 🎬 Lecture: Introduction to Django and Django Rest Framework, and overview of API development.
15+
- 💡 Purpose: Setting the stage and objectives for the tutorial.
16+
17+
## Django Models
18+
19+
- 🎬 Lecture : Fundamentals of Django models.
20+
- 💻 Exercise : Hands-on creation and manipulation of models.
21+
- 💡 Purpose: Understanding data handling in Django.
22+
23+
## URL Mapping and Views
24+
25+
- 🎬 Lecture : Explanation of URL configurations and Views/ViewSets in Django.
26+
- 💻 Exercise : Students implement URL mapping and views for a sample API.
27+
- 💡 Purpose: Practical understanding of Django's routing and controller mechanisms.
28+
29+
## Serializers
30+
31+
- 🎬 Lecture : The role and implementation of serializers.
32+
- 💻 Exercise : Students practice converting data formats using serializers.
33+
- 💡 Purpose: Grasping data format conversions essential in API communication.
34+
35+
## Building an API - Part I
36+
37+
- 💻 Exercise: Students start building a basic API, integrating learned concepts.
38+
- 💡 Purpose: Applying accumulated knowledge in a practical project.
39+
40+
## Lunch/Break
41+
42+
- ⏳ Time for rest and informal discussions.
43+
44+
## Building an API - Part II
45+
46+
- 💻 Exercise: Continuation of the API project with instructor support.
47+
- 💡 Purpose: Completing the API project, reinforcing learning through practice.
48+
49+
## Q&A and Wrap-Up
50+
51+
- 🎬 Lecture: Recap of the day's lessons, addressing questions.
52+
- 💡 Purpose: Ensuring clarity and concluding the session.

0 commit comments

Comments
 (0)