Imported from manarangrhomar-creator/OJT-MONITORING (AGENTS.md). Install upstream with npx skills add manarangrhomar-creator/OJT-MONITORING. Copyright stays with the author.

AGENTS.md — OJT Monitoring System

Commands

No linter, formatter, typechecker, pre-commit, or CI config exists. Tests are minimal placeholders.

Architecture

• Django 4.2 + DRF 3.14, custom User model (apps/core/models.py:9, UUID PK, role in admin|coordinator|student)
• DRF Token Auth (rest_framework.authtoken), CSRF middleware disabled (settings.py:71)
• ASGI via Daphne/Channels — WebSocket consumers at apps/core/consumers.py
• Celery with Redis broker; CELERY_TASK_ALWAYS_EAGER=True by default so tasks run synchronously unless a Redis is running
• SQLite for dev (settings.py:120-126), PostgreSQL in Docker/production; .env PostgreSQL vars are NOT used by settings.py (sqlite3 is hardcoded)
• drf-spectacular at /api/docs/ (Swagger), /api/schema/ (OpenAPI)
• All endpoints use DRF ViewSets + DefaultRouter; check each app's urls.py for generated routes

App structure

Key quirks

• Superusers auto-get role='admin' via post_save signal in apps/core/models.py:52-60
• Login accepts identifier field (username or email)
• Student registration creates StudentProfile but does NOT log user in — requires coordinator approval
• Forgot password uses 3-step OTP flow: send OTP → verify OTP → reset password
• Docker/web entrypoint runs migrate then runserver; no makemigrations step
• The .env file contains real Gmail credentials — do not commit or expose
• ALLOWED_HOSTS includes * — permissive in dev

Frontend

• Django templates in templates/, Tailwind CSS via CDN, vanilla JS
• static/js/auth.js handles token storage, login/register/logout, role-based redirect
• WebSocket at ws://host/ws/notifications/?token=... and ws://host/ws/dashboard/?token=...

Live Dashboard

The coordinator dashboard (templates/coordinator_dashboard.html) has two WebSocket connections:

1. Notifications — connectNotifSocket() for real-time notifications
2. Dashboard — connectDashboardSocket() for live section updates (overview, reports, attendance, applications, sites, students)

broadcast_dashboard_update(section) in apps/core/utils.py broadcasts via DashboardConsumer. It silently catches exceptions, so it won't break existing flows.

Coordinator-side broadcasts are in apps/coordinator/views.py: OJTApplicationViewSet.approve/reject, AttendanceViewSet.clock_in/clock_out, CoordinatorDashboardViewSet.approve_student/reject_student.

Student-side broadcasts are in apps/student/views.py: StudentDashboardViewSet.apply/clock_in/clock_out, StudentNarrativeViewSet.perform_create/submit_with_photos.