# oangelo/calculo-vetorial-exploracao-espacial architecture

> Architecture diagram of the GitHub repository oangelo/calculo-vetorial-exploracao-espacial, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/oangelo/calculo-vetorial-exploracao-espacial
- Repository: https://github.com/oangelo/calculo-vetorial-exploracao-espacial

## Overview

##### Project type and purpose
- This is a static, content-driven educational website built around HTML/CSS and Reveal.js slide decks.
- Its goal is to serve course materials (exercises, slide decks, visualizations) via GitHub Pages.

##### Main components
a. Developer Environment
- Node.js & npm (package.json, package-lock.json)
- Code styling tools (Prettier, Husky pre-commit hooks)
b. Source Code Repository (GitHub)
- Directories of static content:
– slide-decks/ (Reveal.js presentations)
– exercicios/ (chapter exercises and templates)
– visualizacao/ (interactive visualizations)
– investigacao/ (markdown investigation blocks)
– img/ (images and SVGs)
- Configuration files: .gitignore, .prettierrc, PROVAS.MD
- Build scripts and dependencies declared in package.json
c. Continuous Integration / Deployment (CI/CD)
- .github/workflows/deploy-revealjs.yml — upon push, installs npm deps, assembles slide decks, and pushes static files to GitHub Pages
d. Hosting Layer
- GitHub Pages serves the generated static site at the project’s GitHub Pages URL
e. End Users (Students/Instructors)
- Web browsers that request pages, download static assets, and render the content

##### Relationships and interactions
1) Developer edits content or code locally →
2) Husky runs pre-commit checks (linting, formatting) →
3) Push to GitHub triggers CI workflow →
4) CI installs dependencies, runs build steps (if any), packages static files →
5) CI deploy step publishes to GitHub Pages →
6) End user browser requests page →
7) GitHub Pages serves static HTML/CSS/JS →
8) Browser renders interactive slides, exercises, and visualizations

##### Architectural patterns and design principles
- Static Site / Content-as-Code: all teaching materials live as versioned files
- CI/CD Pipeline: full automation of build & deploy to ensure consistency
- Modular Content Structure: each chapter and asset type is grouped in its own directory

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Developer Environment
    subgraph "Developer Environment"
        direction TB
        pack["package.json"]:::dev
        lock["package-lock.json"]:::dev
        pret[".prettierrc"]:::dev
        husky[".husky/pre-commit"]:::dev
    end

    %% GitHub Repository
    pack -->|"push"| Repo[GitHub Repo]
    lock --> Repo
    pret --> Repo
    husky --> Repo

    subgraph "GitHub Repo"
        direction TB
        subgraph "Content Layer"
            direction TB
            sd["slide-decks/"]:::content
            rjs["slide-decks/reveal.js/"]:::content
            tplsd["slide-decks/template.html"]:::content
            ex["exercicios/"]:::content
            ex_temp["exercicios/template.html"]:::content
            ex_css["exercicios/styles.css"]:::content
            ex_guide["exercicios/guia-progressao.md"]:::content
            ex_prompt["exercicios/prompt.md"]:::content
            viz["visualizacao/"]:::content
            inv["investigacao/"]:::content
            img["img/"]:::content
        end
        gitignore[".gitignore"]:::config
        provas["PROVAS.MD"]:::config
        readme["README.md"]:::config
    end

    Repo -->|"trigger CI"| CICD[CI/CD Pipeline]

    %% CI/CD Pipeline
    subgraph "CI/CD Pipeline"
        direction TB
        wf["deploy-revealjs.yml"]:::cicd
        dep["Install Dependencies"]:::cicd
        build["Build Slides"]:::cicd
        deploy["Deploy to Pages"]:::cicd
        wf --> dep --> build --> deploy
    end

    CICD -->|"publish"| Hosting[GitHub Pages]:::hosting
    Hosting -->|"serve"| Browser[End User Browser]:::enduser

    %% Click Events
    click pack "https://github.com/oangelo/calculo-vetorial-exploracao-espacial/blob/main/package.json"
    click lock "https://github.com/oangelo/calculo-vetorial-exploracao-espacial/blob/main/package-lock.json"
    click pret "https://github.com/oangelo/calculo-vetorial-exploracao-espacial/blob/main/.prettierrc"
    click husky "https://github.com/oangelo/calculo-vetorial-exploracao-espacial/tree/main/.husky/pre-commit"
    click sd "https://github.com/oangelo/calculo-vetorial-exploracao-espacial/tree/main/slide-decks/"
    click rjs "https://github.com/oangelo/calculo-vetorial-exploracao-espacial/tree/main/slide-decks/reveal.js/"
    click tplsd "https://github.com/oangelo/calculo-vetorial-exploracao-espacial/blob/main/slide-decks/template.html"
    click ex "https://github.com/oangelo/calculo-vetorial-exploracao-espacial/tree/main/exercicios/"
    click ex_temp "https://github.com/oangelo/calculo-vetorial-exploracao-espacial/blob/main/exercicios/template.html"
    click ex_css "https://github.com/oangelo/calculo-vetorial-exploracao-espacial/blob/main/exercicios/styles.css"
    click ex_guide "https://github.com/oangelo/calculo-vetorial-exploracao-espacial/blob/main/exercicios/guia-progressao.md"
    click ex_prompt "https://github.com/oangelo/calculo-vetorial-exploracao-espacial/blob/main/exercicios/prompt.md"
    click viz "https://github.com/oangelo/calculo-vetorial-exploracao-espacial/tree/main/visualizacao/"
    click inv "https://github.com/oangelo/calculo-vetorial-exploracao-espacial/tree/main/investigacao/"
    click img "https://github.com/oangelo/calculo-vetorial-exploracao-espacial/tree/main/img/"
    click gitignore "https://github.com/oangelo/calculo-vetorial-exploracao-espacial/blob/main/.gitignore"
    click provas "https://github.com/oangelo/calculo-vetorial-exploracao-espacial/blob/main/PROVAS.MD"
    click readme "https://github.com/oangelo/calculo-vetorial-exploracao-espacial/blob/main/README.md"
    click wf "https://github.com/oangelo/calculo-vetorial-exploracao-espacial/blob/main/.github/workflows/deploy-revealjs.yml"

    %% Styles
    classDef dev fill:#ADD8E6,stroke:#000
    classDef content fill:#D8BFD8,stroke:#000
    classDef cicd fill:#98FB98,stroke:#000
    classDef hosting fill:#FFA500,stroke:#000
    classDef config fill:#FFFFE0,stroke:#000
    classDef enduser fill:#F0F0F0,stroke:#000
```
