# lpamorim/projeto-roadmap_ciberseguranca architecture

> Architecture diagram of the GitHub repository lpamorim/projeto-roadmap_ciberseguranca, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-09-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/lpamorim/projeto-roadmap_ciberseguranca
- Repository: https://github.com/lpamorim/projeto-roadmap_ciberseguranca

## Overview

Para desenhar o diagrama de arquitetura do “Roadmap Cibersegurança” de forma precisa e compreensível, siga estas etapas, alinhando-as à estrutura real e aos propósitos do projeto:

##### Identificação do Tipo de Projeto e Propósito
- Trata-se de uma aplicação web full-stack, com frontend estático (HTML/CSS/JS) e backend Node.js/Express, conectando-se a um banco de dados MySQL.
- O objetivo é apresentar rotas de aprendizado em cibersegurança, gerar gráficos e quizzes dinâmicos (via ChartJS e web-dat-viz) e gerenciar usuários.

##### Análise da Estrutura de Arquivos
- Top-level:
- app.js         → Ponto de entrada do servidor Express.
- package.json   → Dependências e scripts.
- .env/.env.dev  → Variáveis de ambiente (porta, credenciais BD).
- Diretório “public”:
- Páginas estáticas (index.html, login.html, cadastro.html, css/, js/, assets/).
- Sub-pastas “roadmap” para cada trilha de conteúdo.
- Diretório “src”:
- src/controllers → Lógica de negócio: insightController.js, quizzController.js, usuarioController.js.
- src/routes      → Definição de rotas Express (GET/POST para /insight, /quizz, /usuarios).
- src/models      → Modelos Sequelize ou classes que representam entidades (Insight, Quizz, Usuario).
- src/database    → Configuração de conexão MySQL e scripts de criação de tabelas.
- Diretório “docs”: Apresenta prototipação de UI e documentação de apoio, mas não faz parte do fluxo de runtime.

##### Padrões Arquiteturais e Tecnologias-Chave
- Padrão MVC (Controllers, Models, Routes).
- Express.js como framework de servidor HTTP.
- MySQL como banco relacional.
- ChartJS e web-dat-viz para visualização de dados no frontend.
- Deploy/execução via Node.js; configurações centralizadas em .env.

##### Como Representar no Diagrama
a. Principais Componentes:
- Cliente (navegador)
- Servidor Web Express (Node.js)
- Banco de Dados MySQL
- Biblioteca de visualização (ChartJS / web-dat-viz)
- Armazenamento de arquivos estáticos (pasta public)
b. Relações e Fluxo de Dados:
1. O usuário faz requisições HTTP/HTTPS ao Express (rotas de login, cadastro, fetch de quizzes e insights).
2. O Controller recebe a requisição → Interage com o Model → Executa queries no MySQL.
3. Resposta JSON retorna ao frontend → Scripts JS (ChartJS) consumem esses dados para renderizar gráficos.
4. Páginas estáticas servidas diretamente da pasta public.
c. Padrões e Princípios:
- Separação de responsabilidades (static assets × lógica de negócio × persistência).
- Configurações externalizadas via .env.
- Uso de MVC para facilitar manutenção e testes.
d. Tecnologias:
- Node.js, Express, MySQL, ChartJS, web-dat-viz, HTML/CSS/JS.

##### Diretrizes para Diagrama Full-Stack
- Separe visualmente o Frontend (Client) do Backend (Server) e do Banco de Dados.
- Mostre claramente o fluxo de requisições HTTP/HTTPS.
- Indique onde os arquivos estáticos (public/) são servidos.
- Demonstre o ciclo Controller → Model → Database.

##### Elementos de Diagrama
- Rótulos claros para cada bloco (p.ex., “Browser”, “Express Server”, “MySQL Database”).
- Setas direcionais para fluxo de dados e chamadas de API.
- Cores/ícones distintos:
- Verde: Frontend estático e bibliotecas de visualização.
- Azul: Servidor Node.js/Express (controllers, routes).
- Laranja: Banco de dados MySQL.
- Notas rápidas ao lado de cada setinha para explicar protocolos ou payloads (JSON, HTML).

Exemplo de disposição:
[Browser] ←(GET /index.html)―→ [Static Server: public/]
│                               │
└―(AJAX /insight, /quizz JSON)→ [Express (app.js)]
│
[Controllers] ──→ [Models] ──→ [MySQL Database]

Resumo: mantenha o diagrama simples, porém completo — represente componentes de frontend, backend e DB, mostre o MVC internamente e ilustre como o ChartJS consome dados da API. Use cores, ícones e setas para clareza máxima.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Frontend Client
    Browser["Browser (Client)"]:::frontend

    %% Frontend Static Assets
    subgraph "Frontend (Static Assets)" 
        direction TB
        IndexHTML["index.html"]:::frontend
        RoadmapFolder["roadmap/"]:::frontend
        CSSFolder["css/"]:::frontend
        JSFolder["js/"]:::frontend
        ChartLibs["ChartJS & web-dat-viz"]:::frontend
    end

    %% Server Layer
    subgraph "Express Server (Node.js/Express)"
        direction TB
        AppJS["app.js"]:::backend
        subgraph "Routes"
            direction TB
            RouteIndex["index.js"]:::backend
            RouteInsight["insight.js"]:::backend
            RouteQuizz["quizz.js"]:::backend
            RouteUsuarios["usuarios.js"]:::backend
        end
        subgraph "Controllers"
            direction TB
            InsightCtrl["insightController.js"]:::backend
            QuizzCtrl["quizzController.js"]:::backend
            UsuarioCtrl["usuarioController.js"]:::backend
        end
        subgraph "Models"
            direction TB
            InsightModel["insightModel.js"]:::backend
            QuizzModel["quizzModel.js"]:::backend
            UsuarioModel["usuarioModel.js"]:::backend
        end
        DBConfig["config.js"]:::backend
        DBScripts["script-tabelas.sql"]:::backend
    end

    %% Database
    MySQLDB["MySQL Database"]:::database

    %% Environment & Package
    EnvFile[".env / .env.dev"]:::config
    PackageJSON["package.json"]:::config

    %% Relationships
    Browser -->|GET /index.html| IndexHTML
    IndexHTML -->|renders HTML| Browser
    Browser -->|AJAX /insight, /quizz| AppJS
    Browser -->|loads CSS/JS| CSSFolder
    Browser -->|loads CSS/JS| JSFolder
    Browser -->|uses| ChartLibs

    AppJS -->|uses Routes| RouteIndex
    AppJS -->|uses Routes| RouteInsight
    AppJS -->|uses Routes| RouteQuizz
    AppJS -->|uses Routes| RouteUsuarios

    RouteIndex -->|calls| InsightCtrl
    RouteInsight -->|calls| InsightCtrl
    RouteQuizz -->|calls| QuizzCtrl
    RouteUsuarios -->|calls| UsuarioCtrl

    InsightCtrl -->|queries| InsightModel
    QuizzCtrl -->|queries| QuizzModel
    UsuarioCtrl -->|queries| UsuarioModel

    InsightModel -->|reads/writes| MySQLDB
    QuizzModel -->|reads/writes| MySQLDB
    UsuarioModel -->|reads/writes| MySQLDB

    DBConfig -->|configures| MySQLDB
    DBScripts -->|initializes| MySQLDB

    AppJS -->|loads env| EnvFile
    AppJS -->|loads pkg| PackageJSON

    %% Click Events
    click IndexHTML "https://github.com/lpamorim/projeto-roadmap_ciberseguranca/blob/main/public/index.html"
    click RoadmapFolder "https://github.com/lpamorim/projeto-roadmap_ciberseguranca/tree/main/public/roadmap/"
    click CSSFolder "https://github.com/lpamorim/projeto-roadmap_ciberseguranca/tree/main/public/css/"
    click JSFolder "https://github.com/lpamorim/projeto-roadmap_ciberseguranca/tree/main/public/js/"
    click Browser "https://github.com/lpamorim/projeto-roadmap_ciberseguranca/tree/main/public/"
    click AppJS "https://github.com/lpamorim/projeto-roadmap_ciberseguranca/blob/main/app.js"
    click EnvFile "https://github.com/lpamorim/projeto-roadmap_ciberseguranca/blob/main/.env"
    click PackageJSON "https://github.com/lpamorim/projeto-roadmap_ciberseguranca/blob/main/package.json"
    click InsightCtrl "https://github.com/lpamorim/projeto-roadmap_ciberseguranca/blob/main/src/controllers/insightController.js"
    click QuizzCtrl "https://github.com/lpamorim/projeto-roadmap_ciberseguranca/blob/main/src/controllers/quizzController.js"
    click UsuarioCtrl "https://github.com/lpamorim/projeto-roadmap_ciberseguranca/blob/main/src/controllers/usuarioController.js"
    click RouteIndex "https://github.com/lpamorim/projeto-roadmap_ciberseguranca/blob/main/src/routes/index.js"
    click RouteInsight "https://github.com/lpamorim/projeto-roadmap_ciberseguranca/blob/main/src/routes/insight.js"
    click RouteQuizz "https://github.com/lpamorim/projeto-roadmap_ciberseguranca/blob/main/src/routes/quizz.js"
    click RouteUsuarios "https://github.com/lpamorim/projeto-roadmap_ciberseguranca/blob/main/src/routes/usuarios.js"
    click InsightModel "https://github.com/lpamorim/projeto-roadmap_ciberseguranca/blob/main/src/models/insightModel.js"
    click QuizzModel "https://github.com/lpamorim/projeto-roadmap_ciberseguranca/blob/main/src/models/quizzModel.js"
    click UsuarioModel "https://github.com/lpamorim/projeto-roadmap_ciberseguranca/blob/main/src/models/usuarioModel.js"
    click DBConfig "https://github.com/lpamorim/projeto-roadmap_ciberseguranca/blob/main/src/database/config.js"
    click DBScripts "https://github.com/lpamorim/projeto-roadmap_ciberseguranca/blob/main/src/database/script-tabelas.sql"

    %% Styles
    classDef frontend fill:#e0f7e9,stroke:#2e7d32,stroke-width:1px
    classDef backend fill:#e3f2fd,stroke:#1565c0,stroke-width:1px
    classDef database fill:#fff3e0,stroke:#ef6c00,stroke-width:1px
    classDef config fill:#f3e5f5,stroke:#6a1b9a,stroke-width:1px
```
