# jackmaa/portfolio architecture

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

- Interactive diagram: https://gitdiagram.com/jackmaa/portfolio
- Repository: https://github.com/jackmaa/portfolio

## Overview

##### Project Type and Purpose
- The README is minimal (“Portfolio”), and the file structure shows an index.html alongside assets that include CSS, JavaScript, and images. This clearly indicates that the project is a static portfolio site designed to showcase personal information, projects, or a professional profile.
- There’s no backend or server-side code, so the entire architecture revolves around client-side static resources.

##### File Structure
- Top-Level File: index.html – This is the entry point of the site and the main page.
- Assets Directory: Contains subdirectories for CSS, JavaScript, and images.
- assets/css: Holds the styling information in SCSS (source file) as well as its generated CSS and (optionally) source maps.
- assets/js: Contains several JavaScript files that seem to implement interactive features (e.g., burger-menu.js for navigation menus, hero.js for possibly animating the hero section, svg-morph.js for SVG transitions, etc.).
- assets/img: Holds image resources used by the website.
- The structure reflects a clear separation of concerns: HTML for structure, CSS/SCSS for styling and layout, and JavaScript for interactivity.

a. Main Components:
- HTML Markup (index.html): Represents the static content and page structure.
- CSS/SCSS Files: Define the visual styling and responsive design.
- JavaScript Files: Provide distinct functionalities for user interactions (like toggling a burger menu, timeline animations, project displays, etc.).
- Images/Assets: Visual content that drives the design aesthetics.

b. Relationships & Interactions:
- The index.html file “loads” and links to both CSS and JavaScript files.
- Within the browser, the CSS is applied to the HTML to render the visual presentation.
- JavaScript is executed on the client-side, interacting with the DOM (provided by index.html) to enable dynamic behaviors (e.g., transition effects, interactive menus, animations).
- Image assets are referenced within both the HTML and possibly CSS for backgrounds or other visual elements.

c. Architectural Patterns & Design Principles:
- Separation of Concerns: Clear division between structure (HTML), styling (CSS/SCSS), and behavior (JavaScript).
- Modularity: The JavaScript files are likely modularized by functionality (burger-menu, timeline, projects etc.), which aids in maintainability.
- Frontend-Focused: Since it is a static site, all processing occurs in the browser without server-side or API layer intervention.

d. Relevant Technologies & Frameworks:
- HTML5 for markup.
- CSS3 and SCSS for styling, with potential source mapping for debugging.
- Vanilla JavaScript (or potentially lightweight libraries) to enhance interactivity.
- No external frameworks are indicated, so the focus is on plain web technologies.

##### Detailed Focus
- Individual features as separate modules where applicable (e.g., “Burger Menu”, “SVG Morphing”, “Hero Section Animation”).
- That the entire system is client-side with no direct external service dependency.
- Be detailed. Even if the system seems simple, showing each functional piece can help in understanding how it all fits together.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "HTML Structure"
        indexHTML["Index.html"]:::html
    end

    subgraph "Styling Layer"
        css["Assets/CSS"]:::css
    end

    subgraph "Behavior Layer"
        js1["Burger Menu"]:::js
        js2["Hero Section"]:::js
        js3["SVG Morphing"]:::js
        js4["Timeline Animations"]:::js
        js5["Projects Module"]:::js
        js6["Console Enhancements"]:::js
        js7["Glitch Effects"]:::js
        js8["Standard Behaviors"]:::js
    end

    subgraph "Assets Layer"
        img["Assets/Images"]:::img
    end

    indexHTML -->|"loads"| css
    indexHTML -->|"loads"| js1
    indexHTML -->|"loads"| js2
    indexHTML -->|"loads"| js3
    indexHTML -->|"loads"| js4
    indexHTML -->|"loads"| js5
    indexHTML -->|"loads"| js6
    indexHTML -->|"loads"| js7
    indexHTML -->|"loads"| js8
    indexHTML -->|"loads"| img

    click indexHTML "https://github.com/jackmaa/portfolio/blob/main/index.html"
    click css "https://github.com/jackmaa/portfolio/tree/main/assets/css"
    click js1 "https://github.com/jackmaa/portfolio/blob/main/assets/js/burger-menu.js"
    click js2 "https://github.com/jackmaa/portfolio/blob/main/assets/js/hero.js"
    click js3 "https://github.com/jackmaa/portfolio/blob/main/assets/js/svg-morph.js"
    click js4 "https://github.com/jackmaa/portfolio/blob/main/assets/js/timeline.js"
    click js5 "https://github.com/jackmaa/portfolio/blob/main/assets/js/projects.js"
    click js6 "https://github.com/jackmaa/portfolio/blob/main/assets/js/console.js"
    click js7 "https://github.com/jackmaa/portfolio/blob/main/assets/js/glitch-link.js"
    click js8 "https://github.com/jackmaa/portfolio/blob/main/assets/js/standard.js"
    click img "https://github.com/jackmaa/portfolio/tree/main/assets/img"

    classDef html fill:#ffcccc,stroke:#333,stroke-width:2px;
    classDef css fill:#ccf2ff,stroke:#333,stroke-width:2px;
    classDef js fill:#ccffcc,stroke:#333,stroke-width:2px;
    classDef img fill:#ffffcc,stroke:#333,stroke-width:2px;
```
