How unb-mds/2023-2-suagradeunb works
Project type and purpose
• This is a full-stack, containerized web application that helps University of Brasília students build and resolve conflicts in their class schedules.
• The backend is a Django REST API (with apps for core business logic, user management, and utilities), and the frontend is a Next.js/React single-page app.
File structure
• Top-level directories:
• api/ – Django project, subdivided into three Django apps (api, users, utils) plus core settings and entrypoints.
• web/ – Next.js app with React components, contexts, hooks, pages, API helper utilities, and styling.
• docker/ & docker-compose.yml – container definitions for the two services (api, web) and the database.
• docs/ – project documentation, including architecture and API docs.
• scripts/ – helper scripts for configuration and testing.
• Key configuration/build files: Makefile, docker-compose.yml, api/requirements.txt, web/package.json, mkdocs.yml.
• Management commands in api/api/management/commands and api/utils/management/commands reveal custom tasks (e.g. updatedb, initadmin).
README for additional insights
• Technologies: Python 3.11, Django 4.2 + Django REST Framework, Node 20 + Next.js, Docker/Compose.
• External integrations: Google OAuth for authentication, SIGAA web scraping to populate course data.
• Architecture link points to a Figma whiteboard with high-level system design.
Elements
• Clear component labels (e.g., “Next.js Frontend”, “Django API”, “PostgreSQL”).
• Blue rectangles for services
• Green rounded rectangles for scheduled jobs or cron tasks
Detail without overthinking
• Break the Django API into sub-components if desired (e.g., Auth module, Schedule module, User module).
• Custom management commands and where they run.
• Ports (e.g., 8000, 3000) and environment variables if relevant to deployment.