# n1kolozz/tbc-final-project architecture

> Architecture diagram of the GitHub repository n1kolozz/tbc-final-project, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-02-15). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/n1kolozz/tbc-final-project
- Repository: https://github.com/n1kolozz/tbc-final-project

## Overview

##### What this project is (type + purpose)
**SheltMe** is a **static, multi-page marketing/informational website** (no backend in this repo) intended to present a platform concept that connects “shelter givers” with “shelter seekers.”
Key evidence:
- README explicitly says: *“This project is a static website and does not require any server-side setup.”*
- File tree: only HTML, CSS, SCSS, images, fonts; no JS app framework, no server code, no API, no database.

##### How the repository is structured (what components exist)
From the file tree, the components are:

##### Static assets
- `images/` (logos, gallery images, favicon, etc.)
- `fonts/` (custom fonts, if used)

##### External libraries (runtime dependencies, likely via CDN in HTML)
Per README:
- Bootstrap 5.3.3
- Animate.css 4.1.1
- Font Awesome (implied by classes)

These should appear as external dependencies “loaded by browser.”

Because it’s static, the “system” is basically:

**User’s Browser**
→ loads **HTML pages**
→ which reference **compiled CSS** and **assets**
→ and also pull **external CDN libraries**
→ navigation moves between HTML documents.

##### Runtime / Deployment View (C4 Container-ish, but static-site version)
Shows what runs where: Browser, static files, external CDNs.

##### Code / Build View
Shows how source SCSS is organized and becomes deliverable CSS.

This avoids cramming build-time and run-time concerns into one picture.

**Client / Runtime**
- **End User**
- **Web Browser**
- **HTML Documents**
- `index.html`
- `pages/About-page.html`
- `pages/Services-page.html`
- `pages/News-page.html`
- `pages/Contact-page.html`
- `pages/Registration-page.html` (UI-only)
- `pages/Sign-in-page.html` (UI-only)
- **Styles**
- `css/styles.css` (compiled)
- **Static Assets**
- `images/*`
- `fonts/*`
- Bootstrap
- Animate.css
- Font Awesome

**Build / Source**
- **SCSS Source**
- `scss/styles.scss` (entry)
- `scss/pages-styles/_variables.scss`
- `scss/pages-styles/_mixins.scss`
- `scss/pages-styles/_reset.scss`
- `scss/pages-styles/_landing-page.scss`, `_about-page.scss`, etc.
- **SCSS Compiler** (tooling not in repo, but implied; label it “Sass compiler (external tool)”)
- Output:
- `css/styles.css`
- `css/styles.css.map`

##### Step 4 — Highlight architectural patterns present

- **Multi-page static site** (MPA) rather than SPA
- **Separation of concerns**:
- Structure: HTML
- Styling: SCSS partials → compiled CSS
- Assets: images/fonts
- **Page-scoped SCSS partials** (`_about-page.scss`, `_news-page.scss`, etc.)
- **Shared design tokens/utilities** (`_variables.scss`, `_mixins.scss`, `_reset.scss`)

##### Feature pages as UI surfaces
- Registration/Sign-in are important *screens* but not “services.”
“Form UI only; no persistence/auth API in this repository.”

- `scss/styles.scss`
- `scss/pages-styles/_variables.scss`, `_mixins.scss`, `_reset.scss`
- page partials `_landing-page.scss`, `_about-page.scss`, etc.
- `css/styles.css`
- `css/styles.css.map`

That will be the most accurate representation of what exists in the repo.

## Diagram (Mermaid)

```mermaid
flowchart TD
  %% =========================
  %% Diagram A: Runtime / Delivery View
  %% =========================
  subgraph "Runtime / Delivery (Static MPA)"
    direction TB

    U["End User"]:::external
    B["Web Browser"]:::runtime

    subgraph "SheltMe Static Site (static files)"
      direction TB

      subgraph "HTML Documents (Multi-Page App)"
        direction TB
        IDX["Landing/Home: index.html"]:::page
        PDIR["Pages Directory (static routes)"]:::dir
        ABT["About: pages/About-page.html"]:::page
        SVC["Services: pages/Services-page.html"]:::page
        NEWS["News: pages/News-page.html"]:::page
        CNT["Contact: pages/Contact-page.html"]:::page
        REG["Registration: pages/Registration-page.html\n(UI-only; no backend in repo)"]:::pageStub
        SIN["Sign-in: pages/Sign-in-page.html\n(UI-only; no backend in repo)"]:::pageStub
      end

      CSS["Stylesheet: css/styles.css"]:::asset
      IMGS[("Images: images/*")]:::store
      FNTS[("Fonts: fonts/*")]:::store
    end

    subgraph "External UI Libraries (loaded via CDN)"
      direction TB
      BS["Bootstrap 5.3.3 (CDN)"]:::cdn
      BSI["Bootstrap Icons 1.11.3 (CDN)"]:::cdn
      ANIM["Animate.css 4.1.1 (CDN)"]:::cdn
      FA["Font Awesome (CDN)"]:::cdn
    end

    subgraph "Notes / Documentation"
      direction TB
      RD["README (setup notes + external libs)"]:::doc
    end
  end

  %% Runtime relationships (vertical)
  U -->|"visits_site/clicks_nav"| B
  B -->|"loads_document"| IDX
  B -->|"loads_document"| ABT
  B -->|"loads_document"| SVC
  B -->|"loads_document"| NEWS
  B -->|"loads_document"| CNT
  B -->|"loads_document"| REG
  B -->|"loads_document"| SIN

  IDX -->|"anchor_nav"| PDIR
  PDIR -->|"contains"| ABT
  PDIR -->|"contains"| SVC
  PDIR -->|"contains"| NEWS
  PDIR -->|"contains"| CNT
  PDIR -->|"contains"| REG
  PDIR -->|"contains"| SIN

  %% Page dependencies
  IDX -->|"links_stylesheet"| CSS
  ABT -->|"links_stylesheet"| CSS
  SVC -->|"links_stylesheet"| CSS
  NEWS -->|"links_stylesheet"| CSS
  CNT -->|"links_stylesheet"| CSS
  REG -->|"links_stylesheet"| CSS
  SIN -->|"links_stylesheet"| CSS

  IDX -->|"loads_assets"| IMGS
  ABT -->|"loads_assets"| IMGS
  SVC -->|"loads_assets"| IMGS
  NEWS -->|"loads_assets"| IMGS
  CNT -->|"loads_assets"| IMGS

  CSS -->|"loads_font_files"| FNTS

  %% External libs pulled by HTML at runtime
  IDX -->|"loads_cdn_css/icons"| BS
  IDX -->|"loads_cdn_css/icons"| BSI
  IDX -->|"loads_cdn_css/animations"| ANIM
  IDX -->|"loads_cdn_icons"| FA

  ABT -->|"loads_cdn_css/icons"| BS
  SVC -->|"loads_cdn_css/icons"| BS
  NEWS -->|"loads_cdn_css/icons"| BS
  CNT -->|"loads_cdn_css/icons"| BS
  REG -->|"loads_cdn_css/icons"| BS
  SIN -->|"loads_cdn_css/icons"| BS

  RD -.->|"documents_dependencies"| BS
  RD -.->|"documents_dependencies"| BSI
  RD -.->|"documents_dependencies"| ANIM
  RD -.->|"documents_dependencies"| FA

  %% =========================
  %% Diagram B: Build / Source View (SCSS -> CSS)
  %% =========================
  subgraph "Build / Source (SCSS Pipeline)"
    direction TB

    subgraph "SCSS Source"
      direction TB
      SCSSENTRY["Entrypoint: scss/styles.scss"]:::build
      PARTDIR["SCSS Partials Directory: scss/pages-styles/"]:::dirBuild

      subgraph "Shared primitives"
        direction TB
        VARS["Design tokens: _variables.scss"]:::build
        MIX["Utilities: _mixins.scss"]:::build
        RST["Base/reset: _reset.scss"]:::build
      end

      subgraph "Page-level partials"
        direction TB
        PLAND["Landing: _landing-page.scss"]:::build
        PABT["About: _about-page.scss"]:::build
        PSVC["Services: _services-page.scss"]:::build
        PNEWS["News: _news-page.scss"]:::build
        PCNT["Contact: _contact-page.scss"]:::build
        PREG["Registration: _registration-page.scss"]:::build
        PSIN["Sign-in: _sign-in-page.scss"]:::build
      end
    end

    COMP["Sass compiler (external tool)"]:::tool

    subgraph "Generated artifacts"
      direction TB
      OUTCSS["Compiled CSS: css/styles.css"]:::artifact
      OUTMAP["Source map: css/styles.css.map"]:::artifact
    end
  end

  %% Build relationships (dashed for build-time)
  VARS -.->|"imported_by"| SCSSENTRY
  MIX -.->|"imported_by"| SCSSENTRY
  RST -.->|"imported_by"| SCSSENTRY

  PLAND -.->|"imported_by"| SCSSENTRY
  PABT -.->|"imported_by"| SCSSENTRY
  PSVC -.->|"imported_by"| SCSSENTRY
  PNEWS -.->|"imported_by"| SCSSENTRY
  PCNT -.->|"imported_by"| SCSSENTRY
  PREG -.->|"imported_by"| SCSSENTRY
  PSIN -.->|"imported_by"| SCSSENTRY

  PARTDIR -.->|"contains_partials"| VARS
  PARTDIR -.->|"contains_partials"| MIX
  PARTDIR -.->|"contains_partials"| RST
  PARTDIR -.->|"contains_partials"| PLAND
  PARTDIR -.->|"contains_partials"| PABT
  PARTDIR -.->|"contains_partials"| PSVC
  PARTDIR -.->|"contains_partials"| PNEWS
  PARTDIR -.->|"contains_partials"| PCNT
  PARTDIR -.->|"contains_partials"| PREG
  PARTDIR -.->|"contains_partials"| PSIN

  SCSSENTRY -.->|"compile"| COMP
  COMP -.->|"generates"| OUTCSS
  COMP -.->|"generates"| OUTMAP

  %% Connect build output to runtime artifact (same file)
  OUTCSS === CSS
  OUTMAP -.->|"debugging_support"| B

  %% =========================
  %% Click Events (from component_mapping)
  %% =========================
  click IDX "https://github.com/n1kolozz/tbc-final-project/blob/main/index.html"
  click ABT "https://github.com/n1kolozz/tbc-final-project/blob/main/pages/About-page.html"
  click SVC "https://github.com/n1kolozz/tbc-final-project/blob/main/pages/Services-page.html"
  click NEWS "https://github.com/n1kolozz/tbc-final-project/blob/main/pages/News-page.html"
  click CNT "https://github.com/n1kolozz/tbc-final-project/blob/main/pages/Contact-page.html"
  click REG "https://github.com/n1kolozz/tbc-final-project/blob/main/pages/Registration-page.html"
  click SIN "https://github.com/n1kolozz/tbc-final-project/blob/main/pages/Sign-in-page.html"
  click PDIR "https://github.com/n1kolozz/tbc-final-project/tree/main/pages/"
  click CSS "https://github.com/n1kolozz/tbc-final-project/blob/main/css/styles.css"
  click OUTCSS "https://github.com/n1kolozz/tbc-final-project/blob/main/css/styles.css"
  click OUTMAP "https://github.com/n1kolozz/tbc-final-project/blob/main/css/styles.css.map"
  click SCSSENTRY "https://github.com/n1kolozz/tbc-final-project/blob/main/scss/styles.scss"
  click PLAND "https://github.com/n1kolozz/tbc-final-project/blob/main/scss/pages-styles/_landing-page.scss"
  click PABT "https://github.com/n1kolozz/tbc-final-project/blob/main/scss/pages-styles/_about-page.scss"
  click PSVC "https://github.com/n1kolozz/tbc-final-project/blob/main/scss/pages-styles/_services-page.scss"
  click PNEWS "https://github.com/n1kolozz/tbc-final-project/blob/main/scss/pages-styles/_news-page.scss"
  click PCNT "https://github.com/n1kolozz/tbc-final-project/blob/main/scss/pages-styles/_contact-page.scss"
  click PREG "https://github.com/n1kolozz/tbc-final-project/blob/main/scss/pages-styles/_registration-page.scss"
  click PSIN "https://github.com/n1kolozz/tbc-final-project/blob/main/scss/pages-styles/_sign-in-page.scss"
  click VARS "https://github.com/n1kolozz/tbc-final-project/blob/main/scss/pages-styles/_variables.scss"
  click MIX "https://github.com/n1kolozz/tbc-final-project/blob/main/scss/pages-styles/_mixins.scss"
  click RST "https://github.com/n1kolozz/tbc-final-project/blob/main/scss/pages-styles/_reset.scss"
  click PARTDIR "https://github.com/n1kolozz/tbc-final-project/tree/main/scss/pages-styles/"
  click IMGS "https://github.com/n1kolozz/tbc-final-project/tree/main/images/"
  click FNTS "https://github.com/n1kolozz/tbc-final-project/tree/main/fonts/"
  click RD "https://github.com/n1kolozz/tbc-final-project/blob/main/README.md"

  %% =========================
  %% Styles
  %% =========================
  classDef runtime fill:#1e88e5,stroke:#0d47a1,color:#ffffff,stroke-width:1px
  classDef page fill:#42a5f5,stroke:#0d47a1,color:#ffffff,stroke-width:1px
  classDef pageStub fill:#64b5f6,stroke:#0d47a1,color:#0b1a2b,stroke-width:1px
  classDef asset fill:#90caf9,stroke:#0d47a1,color:#0b1a2b,stroke-width:1px
  classDef store fill:#b0bec5,stroke:#455a64,color:#102027,stroke-width:1px
  classDef external fill:#8e24aa,stroke:#4a148c,color:#ffffff,stroke-width:1px
  classDef cdn fill:#fb8c00,stroke:#e65100,color:#1b0f00,stroke-width:1px
  classDef doc fill:#ffe082,stroke:#ff6f00,color:#3b2a00,stroke-width:1px

  classDef build fill:#43a047,stroke:#1b5e20,color:#ffffff,stroke-width:1px
  classDef dir fill:#64b5f6,stroke:#0d47a1,color:#0b1a2b,stroke-width:1px
  classDef dirBuild fill:#81c784,stroke:#1b5e20,color:#0b1a2b,stroke-width:1px
  classDef tool fill:#2e7d32,stroke:#1b5e20,color:#ffffff,stroke-width:1px
  classDef artifact fill:#a5d6a7,stroke:#1b5e20,color:#0b1a2b,stroke-width:1px
```
