# wilfierd/isd-2025-optistock architecture

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

- Interactive diagram: https://gitdiagram.com/wilfierd/isd-2025-optistock
- Repository: https://github.com/wilfierd/isd-2025-optistock

## Overview

##### Project Type and Purpose
- This is a full-stack inventory/stock management web application (“Opistock”)
- Frontend: React single-page app in `/client`
- Backend: Node.js API server (likely Express) in the project root (`app.js`, `setupdb.js`, `schema.sql`)
- Database: Relational DB (initialized via `schema.sql` and `setupdb.js`)

##### High-Level File Structure Analysis
- Top level:
- `app.js` – main entry for API server
- `setupdb.js` + `schema.sql` – DB initialization and schema
- `.env` – server-side environment variables (e.g., DB credentials)
- `/client`: React app
- `src/components` – UI components (Dashboard, Materials, QRCodeScanner, etc.)
- `src/hooks` & `src/contexts` – state & data logic
- `src/services/api.js` + `setupProxy.js` – HTTP layer to backend
- `public` – static HTML/CSS assets
- Config & dependency files: `package.json`, `.gitignore`, `.env.development`

##### Key Architectural Insights from README
- Single npm workspace: one command (`npm run dev`) likely runs both server and client (via concurrently or nodemon)
- Uses environment variables to configure DB connection
- Follows typical 3-tier pattern (UI ↔ API ↔ DB)

##### Elements
- From UI to API endpoints (`GET /materials`, `POST /requests`, etc.)
- From API to DB (SQL reads/writes)
- From API to any third-party service (notifications)
- Blue for UI components
- Green for server modules
- Orange for persistence layer

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% UI Layer
    subgraph "UI Layer"  
        direction TB
        Browser["Browser / React SPA"]:::frontend  
        Index["Index Entry (index.js)"]:::frontend  
        Components["UI Components"]:::frontend  
        Hooks["Custom Hooks"]:::frontend  
        Contexts["Context Providers"]:::frontend  
        Services["HTTP Service Layer"]:::frontend  
        Proxy["Dev Proxy (setupProxy.js)"]:::frontend  
        ConfigFE["Frontend Config (config.js)"]:::frontend  
        Styles["Global Styles"]:::frontend  
        Utils["Utility Modules"]:::frontend  
        Tests["Test Setup"]:::frontend  
        EnvFE[".env.development"]:::frontend  
        Public["Static Assets"]:::frontend  
    end

    %% API Layer
    subgraph "API Layer"
        direction TB
        App["API Server (app.js)"]:::backend  
        EnvBE[".env"]:::backend  
        Setup["DB Init Script (setupdb.js)"]:::backend  
        Schema["DB Schema (schema.sql)"]:::database  
        PKG["package.json"]:::backend  
    end

    %% Data Flow
    Browser -->|loads SPA| Index
    Index --> Components
    Index --> Styles
    Components --> Hooks
    Components --> Contexts
    Components --> Services
    Services -->|HTTP/JSON| Proxy
    Proxy -->|forwards to| App

    App -->|reads .env| EnvBE
    App -->|executes| Setup
    App -->|runs schema| Schema
    App -->|uses DB| Schema

    %% Legend / Styles
    classDef frontend fill:#D0E8FF,stroke:#0366D6,color:#0366D6
    classDef backend fill:#DFFFE0,stroke:#2D882D,color:#2D882D
    classDef database fill:#FFE0B2,stroke:#CC5500,color:#CC5500

    %% Click Events - UI
    click Browser "https://github.com/wilfierd/isd-2025-optistock/tree/main/client/"
    click Components "https://github.com/wilfierd/isd-2025-optistock/tree/main/client/src/components/"
    click Hooks "https://github.com/wilfierd/isd-2025-optistock/tree/main/client/src/hooks/"
    click Contexts "https://github.com/wilfierd/isd-2025-optistock/tree/main/client/src/contexts/"
    click Services "https://github.com/wilfierd/isd-2025-optistock/blob/main/client/src/services/api.js"
    click Proxy "https://github.com/wilfierd/isd-2025-optistock/blob/main/client/src/setupProxy.js"
    click Index "https://github.com/wilfierd/isd-2025-optistock/blob/main/client/src/index.js"
    click EnvFE "https://github.com/wilfierd/isd-2025-optistock/blob/main/client/.env.development"
    click Public "https://github.com/wilfierd/isd-2025-optistock/tree/main/client/public/"
    click Styles "https://github.com/wilfierd/isd-2025-optistock/tree/main/client/src/styles/"
    click Utils "https://github.com/wilfierd/isd-2025-optistock/tree/main/client/src/utils/"
    click ConfigFE "https://github.com/wilfierd/isd-2025-optistock/blob/main/client/src/config.js"
    click Tests "https://github.com/wilfierd/isd-2025-optistock/blob/main/client/src/setupTests.js"

    %% Click Events - API
    click App "https://github.com/wilfierd/isd-2025-optistock/blob/main/app.js"
    click EnvBE "https://github.com/wilfierd/isd-2025-optistock/blob/main/.env"
    click Setup "https://github.com/wilfierd/isd-2025-optistock/blob/main/setupdb.js"
    click Schema "https://github.com/wilfierd/isd-2025-optistock/blob/main/schema.sql"
    click PKG "https://github.com/wilfierd/isd-2025-optistock/blob/main/package.json"
```
