# angelikimt/retailhub_project architecture

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

- Interactive diagram: https://gitdiagram.com/angelikimt/retailhub_project
- Repository: https://github.com/angelikimt/retailhub_project

## Overview

##### Project Type and Purpose
- RetailHub is a monolithic, console-based Java application for managing retail operations (clients, products, stores, stock, transactions).
- It follows a layered pattern (presentation → service → persistence) with domain models and JSON export capabilities.

##### File Structure
Top-level files:
– Main.java: application entry point (CLI or driver).
– TestData.java: bootstraps sample data.
– Domain model classes: Client.java, Product.java, Store.java, Stock.java, Transaction.java, Includes.java (models “line items”).
– Service classes: ClientService.java, ProductService.java, StoreService.java, StockService.java, TransactionService.java.
– README.md: overview & features.
Under src/main/java:
– Transaction.java (duplicate or extension?)
– TransactionDAO.java: data-access object for persisting transactions (likely to JSON files).

##### README
- Core modules: client, product, store, stock, transaction management.
- All entities support JSON export.
- No external database is specified; persistence is file‐based via JSON.

##### Main Components & Their Relationships
a. Presentation Layer
– Component: Main (CLI)/TestData
– Role: triggers CRUD and export operations via Services.
b. Service Layer
– Components: *Service classes (ClientService, ProductService, etc.)
– Role: business logic (validations, discount calculations, inventory checks).
c. Persistence Layer
– Component: TransactionDAO (and potentially file-writers within each Service).
– Role: serialize/deserialize entities to/from JSON files.
d. Domain Model
– Components: Entities (Client, Product, Store, Stock, Transaction, Includes).
– Role: data structures passed between layers.
e. External Systems
– JSON file storage (flat files on local filesystem).

##### Architectural Patterns & Principles
- Layered architecture: Presentation → Service → Persistence → Data Store
- Single Monolith: all modules packaged together.
- Separation of concerns: Services orchestrate domain logic; DAOs handle I/O.
- Dependency flow: Presentation depends on Services → Services depend on Models + DAOs.

1) Presentation (Main.java, TestData)
2) Service Layer (ClientService, ProductService, StoreService, StockService, TransactionService)
3) Persistence Layer (TransactionDAO + JSON Export modules)
4) Data Store (Local JSON files)
– Main.java → ClientService, ProductService, etc.
– Each Service → Domain Entities + TransactionDAO (or File I/O)
– TransactionDAO → JSON file store
– Services may also call each other (e.g., TransactionService checks StockService and ClientService).

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Presentation Layer
    subgraph "Presentation Layer"
        direction TB
        Main["Main.java"]:::presentation
        TestData["TestData.java"]:::presentation
    end

    %% Service Layer
    subgraph "Service Layer"
        direction TB
        ClientService["ClientService.java"]:::service
        ProductService["ProductService.java"]:::service
        StoreService["StoreService.java"]:::service
        StockService["StockService.java"]:::service
        TransactionService["TransactionService.java"]:::service
    end

    %% Domain Model
    subgraph "Domain Model"
        direction TB
        Client["Client.java"]:::domain
        Product["Product.java"]:::domain
        Store["Store.java"]:::domain
        Stock["Stock.java"]:::domain
        Transaction["Transaction.java"]:::domain
        Includes["Includes.java"]:::domain
    end

    %% Persistence Layer
    subgraph "Persistence Layer"
        direction TB
        TransactionDAO["TransactionDAO.java"]:::persistence
    end

    %% Data Store
    JSON[(JSON File Store)]:::datastore

    %% Connections
    Main -->|invokes| ClientService
    Main -->|invokes| ProductService
    Main -->|invokes| StoreService
    Main -->|invokes| StockService
    Main -->|invokes| TransactionService
    TestData -->|bootstraps| ClientService
    TestData -->|bootstraps| ProductService
    TestData -->|bootstraps| StoreService
    TestData -->|bootstraps| StockService
    TestData -->|bootstraps| TransactionService

    ClientService -->|uses| Client
    ClientService -->|persists via| TransactionDAO
    ProductService -->|uses| Product
    ProductService -->|persists via| TransactionDAO
    StoreService -->|uses| Store
    StoreService -->|persists via| TransactionDAO
    StockService -->|uses| Stock
    StockService -->|persists via| TransactionDAO
    TransactionService -->|uses| Transaction
    TransactionService -->|uses| Includes
    TransactionService -->|calls| StockService
    TransactionService -->|calls| ClientService
    TransactionService -->|persists via| TransactionDAO

    TransactionDAO -->|reads/writes JSON| JSON

    %% Click Events
    click Main "https://github.com/angelikimt/retailhub_project/blob/main/Main.java"
    click TestData "https://github.com/angelikimt/retailhub_project/blob/main/TestData.java"
    click ClientService "https://github.com/angelikimt/retailhub_project/blob/main/ClientService.java"
    click ProductService "https://github.com/angelikimt/retailhub_project/blob/main/ProductService.java"
    click StoreService "https://github.com/angelikimt/retailhub_project/blob/main/StoreService.java"
    click StockService "https://github.com/angelikimt/retailhub_project/blob/main/StockService.java"
    click TransactionService "https://github.com/angelikimt/retailhub_project/blob/main/TransactionService.java"
    click TransactionDAO "https://github.com/angelikimt/retailhub_project/blob/main/src/main/java/TransactionDAO.java"
    click Client "https://github.com/angelikimt/retailhub_project/blob/main/Client.java"
    click Product "https://github.com/angelikimt/retailhub_project/blob/main/Product.java"
    click Store "https://github.com/angelikimt/retailhub_project/blob/main/Store.java"
    click Stock "https://github.com/angelikimt/retailhub_project/blob/main/Stock.java"
    click Transaction "https://github.com/angelikimt/retailhub_project/blob/main/Transaction.java"
    click Includes "https://github.com/angelikimt/retailhub_project/blob/main/Includes.java"

    %% Styles
    classDef presentation fill:#cce5ff,stroke:#333,stroke-width:1px;
    classDef service fill:#d4edda,stroke:#333,stroke-width:1px;
    classDef persistence fill:#fff3cd,stroke:#333,stroke-width:1px;
    classDef datastore fill:#e2e3e5,stroke:#333,stroke-width:1px;
    classDef domain fill:#f8d7da,stroke:#333,stroke-width:1px;
```
