From e1e3daf5544e8eff3c2e0b458ab5c12378dcbcb4 Mon Sep 17 00:00:00 2001 From: FeliPython <felipejpa15@gmail.com> Date: Sun, 31 Mar 2024 21:08:51 -0300 Subject: [PATCH] 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. --- docs/index.md | 59 ++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 47 insertions(+), 12 deletions(-) diff --git a/docs/index.md b/docs/index.md index 000ea34..6c67e4c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,17 +1,52 @@ -# Welcome to MkDocs +# 🌐 Building Your First API with Django and Django Rest Framework -For full documentation visit [mkdocs.org](https://www.mkdocs.org). +## Summary -## Commands +- **Total Duration:** 3 hours 30 minutes +- **Lecture:** 1 hour (approximately 30%) +- **Exercises:** 2 hours 30 minutes (approximately 70%) -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. -## Project layout +[Presentation slides](https://docs.google.com/presentation/d/1Ajv9MYQQ011_Y4r1W4I6Y-6XP_faFF0317Zkn2XupMw/edit?usp=sharing) 📊 - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. +## Introduction and Overview + +- 🎬 Lecture: Introduction to Django and Django Rest Framework, and overview of API development. +- 💡 Purpose: Setting the stage and objectives for the tutorial. + +## Django Models + +- 🎬 Lecture : Fundamentals of Django models. +- 💻 Exercise : Hands-on creation and manipulation of models. +- 💡 Purpose: Understanding data handling in Django. + +## URL Mapping and Views + +- 🎬 Lecture : Explanation of URL configurations and Views/ViewSets in Django. +- 💻 Exercise : Students implement URL mapping and views for a sample API. +- 💡 Purpose: Practical understanding of Django's routing and controller mechanisms. + +## Serializers + +- 🎬 Lecture : The role and implementation of serializers. +- 💻 Exercise : Students practice converting data formats using serializers. +- 💡 Purpose: Grasping data format conversions essential in API communication. + +## Building an API - Part I + +- 💻 Exercise: Students start building a basic API, integrating learned concepts. +- 💡 Purpose: Applying accumulated knowledge in a practical project. + +## Lunch/Break + +- ⏳ Time for rest and informal discussions. + +## Building an API - Part II + +- 💻 Exercise: Continuation of the API project with instructor support. +- 💡 Purpose: Completing the API project, reinforcing learning through practice. + +## Q&A and Wrap-Up + +- 🎬 Lecture: Recap of the day's lessons, addressing questions. +- 💡 Purpose: Ensuring clarity and concluding the session.