# satishvudata98/filemetadata-modifier architecture

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

- Interactive diagram: https://gitdiagram.com/satishvudata98/filemetadata-modifier
- Repository: https://github.com/satishvudata98/filemetadata-modifier

## Overview

##### Project Type and Purpose
- This is a full-stack web application whose purpose is to let users view, add, and edit metadata (title, author, comments, timestamps) on PDF and image files (JPEG, PNG, GIF).

##### File Structure
- **Top-Level**
- package.json / package-lock.json: root scripts to install and run both frontend and backend.
- filemetadata-modifier/
- **Frontend** (`filemetadata-modifier/frontend/`)
- Vue.js 3 application using Vite (vite.config.js)
- Components in `src/components` (FileUploader.vue, metadata display, edit UI)
- Entry point: `src/main.js` → `App.vue`
- **Backend** (`filemetadata-modifier/backend/`)
- Express server (`server.js`)
- Uses pdf-lib, sharp, exifr for metadata extraction and writing
- Build, start scripts in root and sub-projects (`npm run dev`, etc.)

##### Extract Additional Insights from README
- **API Endpoints** (implied by “Get Metadata”, “Add Comment”, “Edit Comment”)
- **Metadata Storage Patterns**
- PDF metadata embedded via pdf-lib
- JPEG EXIF updated via exifr
- PNG metadata in sidecar `.metadata.json`
- Frontend runs on `http://localhost:5173`, backend on `http://localhost:3001`.

##### Main Components & Their Roles
a. **User Browser / Client**
- Renders Vue UI
- Interacts via HTTP to backend
b. **Vue Frontend**
- File upload component → sends file paths (or contents) to backend
- Metadata viewer/editor UI
- HTTP client (fetch/Axios) to Express API
c. **Express Backend**
- HTTP API layer (e.g., GET `/metadata`, POST `/metadata/add`, PUT `/metadata/edit`)
- Business logic: determine file type, route to appropriate metadata service
d. **Metadata Services**
- **PDF Service** (pdf-lib): extract/modify PDF document properties
- **EXIF Service** (exifr): read/write JPEG EXIF fields
- **PNG Service**: read sidecar `.metadata.json`, write updates
e. **File System / Storage**
- Holds original files, `.metadata.json` for PNG
- Updated files (in-place or overwritten)
f. **Optional Utilities & Config**
- Vite dev server, nodemon (or similar) for hot-reload
- Root scripts to orchestrate concurrent startup

##### Relationships and Interactions
- **Client → Frontend**: User clicks UI, triggers Vue methods
- **Frontend → Backend API**: HTTP requests (JSON payload)
- **Backend → Metadata Service**: function calls to pdf-lib, exifr, or file I/O
- **Metadata Service → File System**: read/write metadata
- **Backend → Frontend**: JSON response containing metadata or success status

##### Architectural Patterns & Principles
- **Layered Architecture**:
- Presentation (Vue)
- Business/API (Express)
- Domain/Service (Metadata handlers)
- Persistence (File system)
- **Separation of Concerns**: each metadata type handled by a dedicated module
- **Stateless API**: each request contains file path & operation, no session state

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Client Layer"
        U["User"]:::external
        VF["Vue Frontend (Vite @5173)"]:::frontend
        U -->|"User Actions"| VF

        subgraph "Frontend Code"
            EP["Entry Point: main.js"]:::frontend
            RC["Root Component: App.vue"]:::frontend
            ME["FileUploader.vue & MetadataEditor.vue"]:::frontend
            PP["Public Assets"]:::frontend
            VC["Vite Config"]:::frontend
        end

        VF -->|"Renders"| EP
        VF -->|"Renders"| RC
        VF -->|"Uses"| ME
        VF -->|"Serves"| PP
        VF -->|"Configured by"| VC
    end

    subgraph "Server Layer"
        API["Express API (Node.js @3001)"]:::backend
        RP["Backend Scripts: package.json"]:::backend
        API -->|"Bootstrapped by"| RP

        subgraph "Metadata Services"
            PDF["PDF Service (pdf-lib)"]:::lib
            EXIF["EXIF Service (exifr)"]:::lib
            PNG["PNG Service (.metadata.json)"]:::service
        end

        API -->|"Calls"| PDF
        API -->|"Calls"| EXIF
        API -->|"Calls"| PNG

        FS["File System"]:::storage
        PDF -->|"Read/Write Metadata"| FS
        EXIF -->|"Read/Write EXIF"| FS
        PNG -->|"Read/Write Sidecar JSON"| FS
    end

    VF -->|"HTTP JSON"| API
    API -->|"JSON Response"| VF

    RP2["Root Scripts: package.json"]:::backend
    RDM["Project README"]:::external
    RDB["Backend README"]:::external
    RDF["Frontend README"]:::external

    %% Additional nodes
    API --- RP2
    RDM
    RDB
    RDF

    classDef frontend fill:#E3F2FD,stroke:#90CAF9;
    classDef backend fill:#FFF3E0,stroke:#FFB74D;
    classDef lib fill:#E8F5E9,stroke:#A5D6A7,stroke-dasharray:5 5;
    classDef service fill:#F3E5F5,stroke:#CE93D8;
    classDef storage fill:#EFEBE9,stroke:#B0BEC5;
    classDef external fill:#FFEBEEE0,stroke:#EF5350;

    click VF "https://github.com/satishvudata98/filemetadata-modifier/tree/master/filemetadata-modifier/frontend/"
    click EP "https://github.com/satishvudata98/filemetadata-modifier/blob/master/filemetadata-modifier/frontend/src/main.js"
    click RC "https://github.com/satishvudata98/filemetadata-modifier/blob/master/filemetadata-modifier/frontend/src/App.vue"
    click ME "https://github.com/satishvudata98/filemetadata-modifier/blob/master/filemetadata-modifier/frontend/src/components/FileUploader.vue"
    click VC "https://github.com/satishvudata98/filemetadata-modifier/blob/master/filemetadata-modifier/frontend/vite.config.js"
    click PP "https://github.com/satishvudata98/filemetadata-modifier/tree/master/filemetadata-modifier/frontend/public/"
    click API "https://github.com/satishvudata98/filemetadata-modifier/blob/master/filemetadata-modifier/backend/server.js"
    click RP "https://github.com/satishvudata98/filemetadata-modifier/blob/master/filemetadata-modifier/backend/package.json"
    click RP2 "https://github.com/satishvudata98/filemetadata-modifier/blob/master/package.json"
    click RDM "https://github.com/satishvudata98/filemetadata-modifier/blob/master/README.md"
    click RDB "https://github.com/satishvudata98/filemetadata-modifier/blob/master/filemetadata-modifier/backend/README.md"
    click RDF "https://github.com/satishvudata98/filemetadata-modifier/blob/master/filemetadata-modifier/frontend/README.md"
```
