# ravneet0628/pdfolio architecture

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

- Interactive diagram: https://gitdiagram.com/ravneet0628/pdfolio
- Repository: https://github.com/ravneet0628/pdfolio

## Overview

##### Project type and purpose
- PDFolio is a single-page, client-side PDF utility web app.
- It’s built with React and Vite, styled with Tailwind CSS, and performs all PDF manipulations in the browser (no backend).

##### File structure
- Top level: configuration files (package.json, vite.config.js, Tailwind via index.css), index.html.
- src/
- main.jsx & index.css: entrypoint & global styles
- App.jsx: root component with router & ThemeContext
- components/: reusable UI bits (Navbar, Footer, Button, Spinner, ScrollToTop, ThemeContext provider)
- pages/: each PDF tool is a page (Merge, Split, Rotate, etc.)
- utils/: core PDF logic (mergePDF, splitPDF, deletePages, outputFilename)
- pdfWorker.js: Web Worker for off-thread PDF processing
- No backend directories—purely a front-end SPA.

##### Extract additional insights from README
- Uses pdf-lib & pdfjs-dist for PDF parsing/manipulation in-browser.
- Drag-and-drop powered by @dnd-kit.
- Vite for dev & build, React Router implied by multi-page structure.

a. Main components:
- Browser/Client
- index.html & Vite bundle
- React App (App.jsx)
- ThemeContext (for dark/light mode)
- Router → Pages (Merge, Split, Compress, etc.)
- Shared Components (Navbar, Footer, Button, Spinner, Grid, Uploader)
- pdfWorker.js (Web Worker)
- Utils (mergePDF, splitPDF, deletePages, etc.)
- Third-party libs (pdf-lib, pdfjs-dist, @dnd-kit, Tailwind)
- Download API (FileSaver/browser download)

b. Relationships & data flow:
1. index.html loads the Vite-bundled JS/CSS.
2. main.jsx mounts App to DOM, wraps it in ThemeContext.
3. App.jsx sets up Router → renders a Page component based on URL.
4. User interacts with a Page (e.g., uploads PDF via FileUploader component).
5. Page posts file data to pdfWorker.js for heavy lifting.
6. pdfWorker uses pdf-lib/pdfjs-dist via utils/*.js to perform operations.
7. Worker returns processed PDF blob back to main thread.
8. Page triggers browser download (saveAs or similar).
9. Shared UI components (LoadingSpinner, SortableThumbnailsGrid) reflect state & drag-and-drop via @dnd-kit.

c. Architectural patterns & principles:
- Component-based UI (React)
- Separation of concerns: UI vs. PDF logic (utils + worker)
- Offload CPU-intensive tasks to Web Worker
- Context API (ThemeContext) for cross-cutting state
- Client-only, no server dependencies → static deployment

d. Key technologies:
- React + React Router
- Vite (dev server/bundler)
- Tailwind CSS
- pdf-lib & pdfjs-dist (PDF manipulation)
- @dnd-kit (drag-and-drop)
- Web Worker (pdfWorker.js)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Build & Deployment
    subgraph "Build & Deployment"
        direction TB
        IndexHTML["index.html"]:::build
        ViteConfig["vite.config.js"]:::build
        GlobalStyles["src/index.css"]:::build
        IndexHTML -->|"serves bundle"| Main
        ViteConfig --> Main
        GlobalStyles --> Main
    end

    %% Browser Client Runtime
    subgraph "Browser (Client)"
        direction TB
        Main["src/main.jsx\n(Application Entrypoint)"]:::build
        App["src/App.jsx\n(Root React Component & Router)"]:::ui
        Main -->|"mounts App"| App

        %% Context & Router
        Theme["ThemeContext.jsx\n(Context Provider)"]:::ui
        Router["React Router"]:::ui
        App -->|"wraps"| Theme
        App -->|"sets up"| Router

        %% Presentation Layer
        subgraph "Presentation Layer"
            direction TB
            subgraph "Shared UI Components"
                Navbar["Navbar"]:::ui
                Footer["Footer"]:::ui
                Button["Button"]:::ui
                FileUploader["FileUploader"]:::ui
                LoadingSpinner["LoadingSpinner"]:::ui
                ScrollToTop["ScrollToTop"]:::ui
                SortableGrid["SortableThumbnailsGrid"]:::ui
                ThumbnailsGrid["ThumbnailsGrid"]:::ui
            end
            subgraph "Page Components"
                Home["Home.jsx"]:::ui
                Merge["Merge.jsx"]:::ui
                Split["Split.jsx"]:::ui
                Rotate["Rotate.jsx"]:::ui
                Compress["Compress.jsx"]:::ui
                Extract["Extract.jsx"]:::ui
                Delete["Delete.jsx"]:::ui
                Duplicate["Duplicate.jsx"]:::ui
                Reorder["Reorder.jsx"]:::ui
                Numbering["PageNumbering.jsx"]:::ui
                Scaling["PageScaling.jsx"]:::ui
                PdfToJpg["PdfToJpg.jsx"]:::ui
                JpgToPdf["JpgToPdf.jsx"]:::ui
            end
        end

        App -->|"renders based on route"| Home
        App --> Merge & Split & Rotate & Compress & Extract & Delete & Duplicate & Reorder & Numbering & Scaling & PdfToJpg & JpgToPdf

        %% Business Logic
        subgraph "Business Logic"
            direction TB
            Worker["pdfWorker.js"]:::logic
            subgraph "Utils"
                mergePDF["mergePDF.js"]:::logic
                splitPDF["splitPDF.js"]:::logic
                deletePages["deletePages.js"]:::logic
                outputFilename["outputFilename.js"]:::logic
            end
        end

        %% Third-Party Libraries
        subgraph "Third-Party Libraries"
            direction TB
            PdfLib["pdf-lib & pdfjs-dist"]:::third
            DndKit["@dnd-kit"]:::third
            Tailwind["Tailwind CSS"]:::third
        end

        %% Interactions
        Home & Merge & Split & Rotate & Compress & Extract & Delete & Duplicate & Reorder & Numbering & Scaling & PdfToJpg & JpgToPdf -->|"upload file"| FileUploader
        FileUploader -->|"postMessage(uploadedFile)"| Worker
        Worker --> PdfLib
        Worker --> splitPDF & mergePDF & deletePages & outputFilename
        DndKit --> SortableGrid
        Worker -->|"onmessage(processedBlob)"| App
        App -->|"trigger download"| Download["Download via FileSaver"]:::third
    end

    %% Click Events
    click IndexHTML "https://github.com/ravneet0628/pdfolio/blob/main/index.html"
    click ViteConfig "https://github.com/ravneet0628/pdfolio/blob/main/vite.config.js"
    click GlobalStyles "https://github.com/ravneet0628/pdfolio/blob/main/src/index.css"
    click Main "https://github.com/ravneet0628/pdfolio/blob/main/src/main.jsx"
    click App "https://github.com/ravneet0628/pdfolio/blob/main/src/App.jsx"
    click Theme "https://github.com/ravneet0628/pdfolio/blob/main/src/components/ThemeContext.jsx"
    click Navbar "https://github.com/ravneet0628/pdfolio/blob/main/src/components/Navbar.jsx"
    click Footer "https://github.com/ravneet0628/pdfolio/blob/main/src/components/Footer.jsx"
    click Button "https://github.com/ravneet0628/pdfolio/blob/main/src/components/Button.jsx"
    click FileUploader "https://github.com/ravneet0628/pdfolio/blob/main/src/components/FileUploader.jsx"
    click LoadingSpinner "https://github.com/ravneet0628/pdfolio/blob/main/src/components/LoadingSpinner.jsx"
    click ScrollToTop "https://github.com/ravneet0628/pdfolio/blob/main/src/components/ScrollToTop.jsx"
    click SortableGrid "https://github.com/ravneet0628/pdfolio/blob/main/src/components/SortableThumbnailsGrid.jsx"
    click ThumbnailsGrid "https://github.com/ravneet0628/pdfolio/blob/main/src/components/ThumbnailsGrid.jsx"
    click Home "https://github.com/ravneet0628/pdfolio/blob/main/src/pages/Home.jsx"
    click Merge "https://github.com/ravneet0628/pdfolio/blob/main/src/pages/Merge.jsx"
    click Split "https://github.com/ravneet0628/pdfolio/blob/main/src/pages/Split.jsx"
    click Rotate "https://github.com/ravneet0628/pdfolio/blob/main/src/pages/Rotate.jsx"
    click Compress "https://github.com/ravneet0628/pdfolio/blob/main/src/pages/Compress.jsx"
    click Extract "https://github.com/ravneet0628/pdfolio/blob/main/src/pages/Extract.jsx"
    click Delete "https://github.com/ravneet0628/pdfolio/blob/main/src/pages/Delete.jsx"
    click Duplicate "https://github.com/ravneet0628/pdfolio/blob/main/src/pages/Duplicate.jsx"
    click Reorder "https://github.com/ravneet0628/pdfolio/blob/main/src/pages/Reorder.jsx"
    click Numbering "https://github.com/ravneet0628/pdfolio/blob/main/src/pages/PageNumbering.jsx"
    click Scaling "https://github.com/ravneet0628/pdfolio/blob/main/src/pages/PageScaling.jsx"
    click PdfToJpg "https://github.com/ravneet0628/pdfolio/blob/main/src/pages/PdfToJpg.jsx"
    click JpgToPdf "https://github.com/ravneet0628/pdfolio/blob/main/src/pages/JpgToPdf.jsx"
    click Worker "https://github.com/ravneet0628/pdfolio/blob/main/src/pdfWorker.js"
    click mergePDF "https://github.com/ravneet0628/pdfolio/blob/main/src/utils/mergePDF.js"
    click splitPDF "https://github.com/ravneet0628/pdfolio/blob/main/src/utils/splitPDF.js"
    click deletePages "https://github.com/ravneet0628/pdfolio/blob/main/src/utils/deletePages.js"
    click outputFilename "https://github.com/ravneet0628/pdfolio/blob/main/src/utils/outputFilename.js"

    %% Styles
    classDef ui fill:#D4E6FC,stroke:#1B4F72,stroke-width:1px
    classDef logic fill:#D5F5E3,stroke:#196F3D,stroke-width:1px
    classDef third fill:#FDEBD0,stroke:#BA4A00,stroke-width:1px
    classDef build fill:#E5E7E9,stroke:#616A6B,stroke-width:1px
    classDef boundary stroke-dasharray: 5 5;background:none;;
```
