📘 Digital Attendance System – API Docs

🎯 Project Overview

A robust backend solution built using Django and Django REST Framework to manage classroom attendance via QR code scanning. Replaces outdated manual processes with secure, digital automation.

• Teachers generate QR codes to mark session attendance.
• Students scan QR to mark themselves present.
• Role-based access: teachers manage classes, students enroll.
• Reports and attendance summaries available via API.

🔍 View Swagger UI 📄 View Redoc 🔍 Testing Guide

🧩 Key Features

Feature	Description	Permissions
User Authentication	JWT-based secure login	Register, Login, Token refresh
Class Management	Teachers create/update/delete classes	Teacher only
Enrollment	Students enroll in classes	Student only
QR Code Generation	QR code per session UUID	Teacher only
Attendance Tracking	Student scans QR to mark present	Student only
Reports	Attendance summary by class/student	Both roles

🛠️ Technologies

• Backend: Django, Django REST Framework
• Auth: Simple JWT
• QR Code: Pillow + qrcode
• Docs: Swagger via drf-yasg
• DB: PostgreSQL or SQLite
• Extras: send_mail, CSV export, admin dashboard

🧱 Model Structures

🔐 User (Custom User Model)

• username – string
• email – string
• password – string (hashed)
• role – choice (teacher/student)
• institution – FK (optional)

🏫 Classroom

• name – string
• subject – string
• teacher – FK to User

📋 Enrollment

• student – FK to User
• classroom – FK to Classroom

📷 Session

• classroom – FK to Classroom
• session_id – UUID
• date – Date
• qr_code_image – Image file

📝 Attendance

• student – FK to User
• session – FK to Session
• status – string ("present")
• timestamp – DateTime

🔐 Auth Endpoints

• POST /auth/register/ – Register a user
• POST /auth/token/ – Obtain JWT
• POST /api/auth/token/refresh/ – Refresh token

🏫 Classroom Endpoints

• GET /api/classrooms/ – List all classrooms
• POST /api/classrooms/ – Create a classroom
• GET /api/classrooms/{id}/ – View class detail
• PUT /api/classrooms/{id}/ – Update class
• PATCH /api/classrooms/{id}/ – Partial update
• DELETE /api/classrooms/{id}/ – Delete class
• POST /api/classrooms/{id}/enroll/ – Enroll student

📷 Attendance & QR Endpoints

• POST /api/attendance/classrooms/{id}/generate-session/ – Generate session QR
• POST /api/attendance/mark/ – Submit QR and mark attendance
• GET /api/attendance/student/{student_id}/summary/ – Student attendance summary (all time)
• GET /api/attendance/student/{id}/summary/?start_date=&end_date= – Student summary within date range [Additional]
• GET /api/attendance/class/{class_id}/summary/ – Class attendance summary (all time)
• GET /api/attendance/class/{id}/summary/?start_date=&end_date= – Class summary within date range [Additional]
• GET /api/attendance/class/{class_id}/export/ – Export attendance CSV [BONUS]
• GET /api/attendance/dashboard/summary/ – System-wide attendance summary [BONUS]

📦 Deployment & Hosting

• Deployed on Render with auto-deploy from GitHub
• Free PostgreSQL database instance attached by Railway
• Static files handled via WhiteNoise
• Environment variables configured via Render dashboard