# da-upm/participa architecture

> Architecture diagram of the GitHub repository da-upm/participa, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/da-upm/participa
- Repository: https://github.com/da-upm/participa

## Overview

##### Main Components

a) Frontend Layer:
- Views (Templates) Component
- EJS template structure
- Static assets (JS, CSS, images)
- Client-side Authentication Component
- Autoscript.js integration for client authentication

b) Backend Layer:
- Controller Layer
- Admin Controller
- Commitment Controller
- Proposal Controller
- Question Controller
- User Controller
- Views Controller

c) Model Layer:
- Data Models
- User
- Candidate
- Commitment
- Proposal
- Question
- Parameter

d) External Services:
- Email Service (indicated by email templates)
- Authentication Service
- PDF Generation Service (LaTeX integration)

##### Architecture Pattern

**[Client Browser] ←→ [Views Layer (EJS Templates)]**
- ↕
**[Controllers Layer]**
- ↕
**[Models Layer] ←→ [Database]**

##### Key Relationships to Highlight

- Flow from routes through controllers to models
- Template rendering process
- Demonstrate email notification system
- PDF generation workflow
- Authentication flow

##### Additional Elements

- Docker container boundaries (indicated by Dockerfile and docker-compose.yaml)
- OpenAPI integration (indicated by openapi.yaml)
- Demonstrate static asset serving
- Error handling flow

**[Client Layer]**
- ↓
**[Application Container]**
- [Web Server]
- [Template Engine]
- [Controllers]
- [Models]
- [Services]
- [Email Service]
- [PDF Service]
- [Auth Service]

##### Important Notes

- Use clear labels for all components
- Notes for important configurations or dependencies
- Relationship between different template fragments
- Flow of proposal management

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Client
        Browser["Web Browser"]
        Auth["Client Authentication"]:::auth
    end

    subgraph "Frontend Layer"
        Views["Views/Templates"]:::frontend
        Static["Static Assets"]:::frontend
        EmailTemplates["Email Templates"]:::frontend
    end

    subgraph "Routes Layer"
        AdminRoutes["Admin Routes"]:::route
        CommitmentRoutes["Commitment Routes"]:::route
        ProposalRoutes["Proposal Routes"]:::route
        QuestionRoutes["Question Routes"]:::route
        UserRoutes["User Routes"]:::route
        ViewsRoutes["Views Routes"]:::route
    end

    subgraph "Controllers Layer"
        AdminController["Admin Controller"]:::controller
        CommitmentController["Commitment Controller"]:::controller
        LoginController["Login Controller"]:::controller
        ProposalController["Proposal Controller"]:::controller
        QuestionController["Question Controller"]:::controller
        UserController["User Controller"]:::controller
        ViewController["Views Controller"]:::controller
    end

    subgraph "Model Layer"
        User["User Model"]:::model
        Candidate["Candidate Model"]:::model
        Commitment["Commitment Model"]:::model
        Proposal["Proposal Model"]:::model
        Question["Question Model"]:::model
        Parameter["Parameter Model"]:::model
    end

    subgraph "External Services"
        EmailService["Email Service"]:::service
        PDFService["PDF Generation Service"]:::service
        DB[(Database)]:::database
    end

    Browser --> Auth
    Browser --> Views
    Views --> Static
    
    Views --> AdminRoutes
    Views --> CommitmentRoutes
    Views --> ProposalRoutes
    Views --> QuestionRoutes
    Views --> UserRoutes
    Views --> ViewsRoutes

    AdminRoutes --> AdminController
    CommitmentRoutes --> CommitmentController
    ProposalRoutes --> ProposalController
    QuestionRoutes --> QuestionController
    UserRoutes --> UserController
    ViewsRoutes --> ViewController
    Auth --> LoginController

    AdminController --> User
    AdminController --> Candidate
    CommitmentController --> Commitment
    ProposalController --> Proposal
    QuestionController --> Question
    UserController --> User
    ViewController --> Parameter

    User --> DB
    Candidate --> DB
    Commitment --> DB
    Proposal --> DB
    Question --> DB
    Parameter --> DB

    ProposalController --> EmailService
    EmailService --> EmailTemplates
    ProposalController --> PDFService

    %% Click Events
    click Views "https://github.com/da-upm/participa/tree/main/src/templates"
    click Auth "https://github.com/da-upm/participa/blob/main/src/templates/static/js/autoscript.js"
    click Static "https://github.com/da-upm/participa/tree/main/src/templates/static"
    click EmailTemplates "https://github.com/da-upm/participa/tree/main/src/templates/emails"
    click AdminController "https://github.com/da-upm/participa/blob/main/src/controllers/adminController.js"
    click CommitmentController "https://github.com/da-upm/participa/blob/main/src/controllers/commitmentController.js"
    click LoginController "https://github.com/da-upm/participa/blob/main/src/controllers/loginController.js"
    click ProposalController "https://github.com/da-upm/participa/blob/main/src/controllers/proposalController.js"
    click QuestionController "https://github.com/da-upm/participa/blob/main/src/controllers/questionController.js"
    click UserController "https://github.com/da-upm/participa/blob/main/src/controllers/userController.js"
    click ViewController "https://github.com/da-upm/participa/blob/main/src/controllers/viewsController.js"
    click User "https://github.com/da-upm/participa/blob/main/src/models/user.js"
    click Candidate "https://github.com/da-upm/participa/blob/main/src/models/candidate.js"
    click Commitment "https://github.com/da-upm/participa/blob/main/src/models/commitment.js"
    click Proposal "https://github.com/da-upm/participa/blob/main/src/models/proposal.js"
    click Question "https://github.com/da-upm/participa/blob/main/src/models/question.js"
    click Parameter "https://github.com/da-upm/participa/blob/main/src/models/parameter.js"
    click AdminRoutes "https://github.com/da-upm/participa/blob/main/src/routes/admin.js"
    click CommitmentRoutes "https://github.com/da-upm/participa/blob/main/src/routes/commitment.js"
    click ProposalRoutes "https://github.com/da-upm/participa/blob/main/src/routes/proposal.js"
    click QuestionRoutes "https://github.com/da-upm/participa/blob/main/src/routes/question.js"
    click UserRoutes "https://github.com/da-upm/participa/blob/main/src/routes/user.js"
    click ViewsRoutes "https://github.com/da-upm/participa/blob/main/src/routes/views.js"
    click PDFService "https://github.com/da-upm/participa/tree/main/src/latex"

    %% Styling
    classDef frontend fill:#2196F3,stroke:#1565C0,color:white
    classDef controller fill:#4CAF50,stroke:#2E7D32,color:white
    classDef model fill:#FFC107,stroke:#FFA000,color:black
    classDef service fill:#9C27B0,stroke:#7B1FA2,color:white
    classDef database fill:#607D8B,stroke:#455A64,color:white
    classDef auth fill:#F44336,stroke:#D32F2F,color:white
    classDef route fill:#FF9800,stroke:#F57C00,color:white
```
