# breymene/rubricas-itm architecture

> Architecture diagram of the GitHub repository breymene/rubricas-itm, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/breymene/rubricas-itm
- Repository: https://github.com/breymene/rubricas-itm

## Overview

##### Project Type and Purpose
- This is a full-stack web application (“RubrITM”) for ITM university, built to let professors create, manage, and share evaluation rubrics.
- Frontend: Vue.js with Nuxt.js (SSR/SPA hybrid)
- Backend: Node.js with Express
- Database: MongoDB
- Deployment: Docker Compose with Nginx as a reverse proxy

##### File Structure
- Top-level:
- Backend/ – Express server (index.js, routes/, utils/)
- Web/ – Nuxt application (pages/, components/, layouts/, middleware/, server/)
- docker-compose.yml + nginx.conf – container orchestration & reverse proxy
- Backend:
- routes/auth.js, course.js, groups.js – API controllers
- utils/types.js, validations.js – shared validation and custom types
- Web:
- pages/ – Nuxt routes for Curso, Login, rubricas, etc.
- components/ – Vue components for Create, Register, Rubrica UI, Utilities
- middleware/auth.global.ts – global auth guard
- server/ – Nuxt server middleware (TS)
- nuxt.config.ts, tailwind.config.js – framework configuration

##### Extract README Insights
- API_URL set to http://localhost:8000
- MongoDB URI points at “db” service in Docker network
- Professors and students roles, email notifications sent via Outlook

##### Main Components & Relationships
a. Components:
- Client Browser (User interface)
- Nginx Reverse Proxy
- Frontend (Nuxt.js SSR/SPA)
- Backend API (Express.js)
- MongoDB Database
- External Email Service (Outlook SMTP)
b. Data Flows:
1. User → Browser loads URL → Nginx
2. Nginx → serves static assets / proxies to Nuxt server
3. Nuxt → SSR or API fetch → calls Backend at /auth, /groups, /course
4. Backend → performs business logic → reads/writes MongoDB
5. Backend → sends grading emails via Outlook SMTP
c. Architectural Patterns:
- MVC-style within backend (routes = controllers, utils = services)
- Component-based UI (Vue/Nuxt)
- Docker-based micro-services (each service in its own container)
- API gateway pattern via Nginx
d. Key Technologies:
- Nuxt.js / Vue.js (Frontend framework)
- Express.js (Backend framework)
- MongoDB (NoSQL database)
- Docker Compose & Nginx (Deployment and reverse proxy)
- TailwindCSS (Styling)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Clients and Entry
    Browser["Client Browser"]:::ui
    Nginx["Nginx Reverse Proxy"]:::infra
    Compose["Docker Compose"]:::infra

    %% Docker Network Boundary
    subgraph "Docker Network"
        direction TB
        subgraph "Frontend Service"
            direction TB
            Web["Nuxt Frontend"]:::ui
            subgraph "Frontend Components"
                direction TB
                Pages["pages/"]:::ui
                Components["components/"]:::ui
                DefaultLayout["layouts/default.vue"]:::ui
                LoginNav["layouts/loginNav.vue"]:::ui
                Middleware["middleware/auth.global.ts"]:::ui
                ServerM["server/"]:::ui
                NuxtConfig["nuxt.config.ts"]:::ui
                TailwindConfig["tailwind.config.js"]:::ui
            end
        end

        subgraph "Backend Service"
            direction TB
            API["Express Backend"]:::api
            subgraph "Backend Components"
                direction TB
                Entry["index.js"]:::api
                RoutesAuth["routes/auth.js"]:::api
                RoutesCourse["routes/course.js"]:::api
                RoutesGroups["routes/groups.js"]:::api
                UtilsTypes["utils/types.js"]:::api
                UtilsVal["utils/validations.js"]:::api
                Dockerfile["dockerfile"]:::infra
            end
        end

        DB["MongoDB"]:::data
    end

    SMTP["Outlook SMTP"]:::external

    %% Connections
    Browser -->|HTTP| Nginx
    Nginx -->|serve static / proxy SSR| Web
    Web -->|REST API| API
    API -->|CRUD| DB
    API -->|SMTP email| SMTP

    %% Click Events
    click Nginx "https://github.com/breymene/rubricas-itm/blob/main/nginx.conf"
    click Compose "https://github.com/breymene/rubricas-itm/blob/main/docker-compose.yml"
    click Pages "https://github.com/breymene/rubricas-itm/tree/main/Web/pages/"
    click Components "https://github.com/breymene/rubricas-itm/tree/main/Web/components/"
    click DefaultLayout "https://github.com/breymene/rubricas-itm/blob/main/Web/layouts/default.vue"
    click LoginNav "https://github.com/breymene/rubricas-itm/blob/main/Web/layouts/loginNav.vue"
    click Middleware "https://github.com/breymene/rubricas-itm/blob/main/Web/middleware/auth.global.ts"
    click ServerM "https://github.com/breymene/rubricas-itm/tree/main/Web/server/"
    click NuxtConfig "https://github.com/breymene/rubricas-itm/blob/main/Web/nuxt.config.ts"
    click TailwindConfig "https://github.com/breymene/rubricas-itm/blob/main/Web/tailwind.config.js"
    click Entry "https://github.com/breymene/rubricas-itm/blob/main/Backend/index.js"
    click RoutesAuth "https://github.com/breymene/rubricas-itm/blob/main/Backend/routes/auth.js"
    click RoutesCourse "https://github.com/breymene/rubricas-itm/blob/main/Backend/routes/course.js"
    click RoutesGroups "https://github.com/breymene/rubricas-itm/blob/main/Backend/routes/groups.js"
    click UtilsTypes "https://github.com/breymene/rubricas-itm/blob/main/Backend/utils/types.js"
    click UtilsVal "https://github.com/breymene/rubricas-itm/blob/main/Backend/utils/validations.js"
    click Dockerfile "https://github.com/breymene/rubricas-itm/tree/main/Backend/dockerfile"
    click DB "https://github.com/breymene/rubricas-itm/blob/main/docker-compose.yml"

    %% Styles
    classDef ui fill:#CCE5FF,stroke:#1E90FF,color:#000
    classDef api fill:#D5FFD5,stroke:#32CD32,color:#000
    classDef data fill:#FFE5CC,stroke:#FF8C00,color:#000
    classDef external fill:#F0F0F0,stroke:#A9A9A9,color:#000
    classDef infra fill:#E8E8E8,stroke:#808080,color:#000
```
