# adilraq/portfolio architecture

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

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

## Overview

##### Project type and purpose
- Type: Single‐Page Application (SPA) built with React (bootstrapped via Create React App).
- Purpose: A personal/portfolio site showcasing About, Articles, Projects, and a downloadable resume.

##### High-level analysis of the file structure
- .storybook: component playground for UI development (Storybook).
- public/: static assets (index.html, resume.pdf).
- src/: React source – entry point (index.tsx), App shell (App.tsx, Layout.tsx), components (UI library), pages (About, Articles, Projects), data.tsx.
- build tool config: webpack.config.js, tailwind.config.js, tsconfig.json.
- package.json: dependencies (React, Tailwind, Storybook, Webpack), scripts (start, build, test, storybook).

##### Key insights from README
- Uses CRA conventions: webpack under the hood, development server, production build.
- Standard npm scripts for start, test, build, eject.

##### Main components
A. Developer Environment
– IDE/Code Editor
– Source Repo (Git)
– Storybook (Component Dev Server)
– Webpack Dev Server (npm start)
B. Build Pipeline
– Webpack (bundling JS/CSS/assets)
– Tailwind CSS processing
– Babel/TypeScript transpilation
C. Deployment Artifacts
– Static files: index.html, bundle.js, styles.css, resume.pdf
D. Runtime in Browser
– React SPA
– React Router (or internal nav) controlling Views
– UI Components (Accordion, Button, NavBar, Badge, etc.)
– Data Layer (data.tsx for projects/articles metadata)

##### Relationships & interactions
1. Developer writes code → commits to Git
2. On `npm start`: Webpack Dev Server serves index.html + live‐reloaded JS chunks
3. Storybook runs in parallel for isolated component testing
4. On `npm run build`: Webpack + Babel + Tailwind produce optimized static bundle
5. Static files deployed to CDN or static host (e.g., Netlify, Vercel)
6. Browser requests index.html → loads bundle.js → React hydrates the SPA → user navigates through pages → UI components fetch data from data.tsx

##### Architectural patterns & design principles
- Component‐based UI: reusable, isolated components organized under src/components, enhanced via Storybook.
- Separation of concerns: Layout vs. Page vs. Component vs. Data.
- Build‐time theming/styling: Tailwind CSS integrated via PostCSS in Webpack.
- Single entry point (index.tsx) → root React tree (App → Layout → NavBar + Page content).

##### What to label explicitly
- “Webpack Dev Server” vs. “Storybook Server”
- “Transpile & Bundle” process (Babel + TypeScript + Tailwind)
- “Static Host / CDN” as deployment target
- React root structure: App → Layout → NavBar + Pages → Components

## Diagram (Mermaid)

```mermaid
graph TB
    %% Developer Environment
    subgraph "Developer Environment"
        IDE["IDE/Code Editor"]:::dev
        Git["Source Repo (Git)"]:::dev
        Storybook["Storybook Server"]:::dev
        WebpackDev["Webpack Dev Server"]:::dev
    end

    %% Build Pipeline
    subgraph "Build Pipeline"
        NpmBuild["npm run build"]:::build
        Transpile["Babel & TypeScript"]:::build
        CSSProcess["Tailwind CSS Processor"]:::build
        Bundler["Webpack"]:::build
    end

    %% Deployment Artifacts
    subgraph "Deployment"
        StaticHost["Static Host / CDN"]:::deploy
        IndexHTML["index.html"]:::assets
        Resume["resume.pdf"]:::assets
        BundleJS["bundle.js"]:::assets
        StylesCSS["styles.css"]:::assets
    end

    %% Runtime (Browser)
    subgraph "Runtime (Browser)"
        Browser["Browser"]:::runtime
        AppEntry["src/index.tsx"]:::runtime
        IndexCSS["src/index.css"]:::runtime
        AppComp["App.tsx"]:::runtime
        LayoutComp["Layout.tsx"]:::runtime
        NavBarComp["NavBar.tsx"]:::runtime
        subgraph "Page Views"
            About["About.tsx"]:::runtime
            Articles["Articles.tsx"]:::runtime
            Projects["Projects.tsx"]:::runtime
        end
        subgraph "UI Components Library"
            Accordion["Accordion.tsx"]:::runtime
            Badge["Badge.tsx"]:::runtime
            Button["Button.tsx"]:::runtime
            HoverButton["HoverButton.tsx"]:::runtime
            LinkComp["Link.tsx"]:::runtime
            Techs["Techs.tsx"]:::runtime
        end
        DataModule["data.tsx"]:::runtime
    end

    %% Component Playground (Storybook Stories)
    subgraph "Component Playground"
        StoryAccordion["AccordionItem.stories.tsx"]:::dev
        StoryButton["Button.stories.tsx"]:::dev
        StoryBadge["badge.stories.tsx"]:::dev
    end

    %% Flows
    IDE --> Git
    Git -->|"dev server"| WebpackDev
    Git -->|"run storybook"| Storybook
    WebpackDev -->|"serves"| Browser
    Storybook --> StoryAccordion
    Storybook --> StoryButton
    Storybook --> StoryBadge

    Git -->|"build"| NpmBuild
    NpmBuild --> Transpile
    NpmBuild --> CSSProcess
    NpmBuild --> Bundler
    Bundler --> BundleJS
    Bundler --> StylesCSS
    CSSProcess --> StylesCSS
    Transpile --> BundleJS

    publicAssets["public"]:::assets
    publicAssets --> IndexHTML
    publicAssets --> Resume

    BundleJS --> StaticHost
    StylesCSS --> StaticHost
    IndexHTML --> StaticHost
    Resume --> StaticHost

    StaticHost --> Browser

    Browser --> AppEntry
    Browser --> IndexCSS
    AppEntry --> AppComp
    AppEntry --> LayoutComp
    AppComp --> NavBarComp
    AppComp --> DataModule
    LayoutComp --> NavBarComp
    LayoutComp --> About
    LayoutComp --> Articles
    LayoutComp --> Projects
    About --> DataModule
    Articles --> DataModule
    Projects --> DataModule
    NavBarComp --> LinkComp
    NavBarComp --> Badge
    NavBarComp --> Button

    AppComp --> Accordion
    AppComp --> Badge
    AppComp --> Button
    AppComp --> HoverButton
    AppComp --> LinkComp
    AppComp --> Techs

    %% Click Events
    click Storybook "https://github.com/adilraq/portfolio/blob/main/.storybook/main.ts"
    click WebpackDev "https://github.com/adilraq/portfolio/blob/main/webpack.config.js"
    click Storybook "https://github.com/adilraq/portfolio/blob/main/.storybook/preview.ts"
    click NpmBuild "https://github.com/adilraq/portfolio/blob/main/package.json"
    click CSSProcess "https://github.com/adilraq/portfolio/blob/main/tailwind.config.js"
    click Transpile "https://github.com/adilraq/portfolio/blob/main/tsconfig.json"
    click IndexHTML "https://github.com/adilraq/portfolio/blob/main/public/index.html"
    click Resume "https://github.com/adilraq/portfolio/blob/main/public/resume.pdf"
    click AppEntry "https://github.com/adilraq/portfolio/blob/main/src/index.tsx"
    click IndexCSS "https://github.com/adilraq/portfolio/blob/main/src/index.css"
    click AppComp "https://github.com/adilraq/portfolio/blob/main/src/App.tsx"
    click LayoutComp "https://github.com/adilraq/portfolio/blob/main/src/Layout.tsx"
    click DataModule "https://github.com/adilraq/portfolio/blob/main/src/data.tsx"
    click Accordion "https://github.com/adilraq/portfolio/blob/main/src/components/Accordion.tsx"
    click Badge "https://github.com/adilraq/portfolio/blob/main/src/components/Badge.tsx"
    click Button "https://github.com/adilraq/portfolio/blob/main/src/components/Button.tsx"
    click HoverButton "https://github.com/adilraq/portfolio/blob/main/src/components/HoverButton.tsx"
    click LinkComp "https://github.com/adilraq/portfolio/blob/main/src/components/Link.tsx"
    click NavBarComp "https://github.com/adilraq/portfolio/blob/main/src/components/NavBar.tsx"
    click Techs "https://github.com/adilraq/portfolio/blob/main/src/components/Techs.tsx"
    click About "https://github.com/adilraq/portfolio/blob/main/src/pages/About.tsx"
    click Articles "https://github.com/adilraq/portfolio/blob/main/src/pages/Articles.tsx"
    click Projects "https://github.com/adilraq/portfolio/blob/main/src/pages/Projects.tsx"
    click StoryAccordion "https://github.com/adilraq/portfolio/blob/main/src/stories/AccordionItem.stories.tsx"
    click StoryButton "https://github.com/adilraq/portfolio/blob/main/src/stories/Button.stories.tsx"
    click StoryBadge "https://github.com/adilraq/portfolio/blob/main/src/stories/badge.stories.tsx"

    %% Styles
    classDef dev fill:#d4f8d4,stroke:#333,stroke-width:1px
    classDef build fill:#d0e0ff,stroke:#333,stroke-width:1px
    classDef assets fill:#f0f0f0,stroke:#333,stroke-width:1px
    classDef deploy fill:#cccccc,stroke:#333,stroke-width:1px
    classDef runtime fill:#ffe0b2,stroke:#333,stroke-width:1px
```
