# ishan-aggarwal/low_level_design_by_ishan architecture

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

- Interactive diagram: https://gitdiagram.com/ishan-aggarwal/low_level_design_by_ishan
- Repository: https://github.com/ishan-aggarwal/low_level_design_by_ishan

## Overview

##### Main Modules
- Repository Root – This is the “Low-Level Design Series” which serves as an umbrella over all topics.
- OOP Module – Contains examples and basic concepts of object-oriented programming.
- SOLID Design Principles – Demonstrates the implementation of SOLID principles in multiple versions.
- Design Patterns – Organized into further submodules:
– Creational Patterns
– Structural Patterns (with further examples like Adapter, Bridge, Composite, Decorator, Facade, Flyweight, Proxy, etc.)
– Behavioral Patterns (Chain of Responsibility, Command, Iterator, Mediator, Memento, Observer, State, Strategy, Template, Visitor)
- Low-Level Design Problems – A huge collection of domain-specific problems (like Design Pen, TicTacToe, Vending Machine, Amazon Locker, Splitwise, Car Rental System, etc.). Each problem has its own folder and further substructure (e.g., “Others”, “design-api-rate-limiter-v2”, “design-atm”, etc.).
- Additional Modules – For example “design_principles”, “design_patterns”, “low_level_design”, “oop” at the root level all represent key teaching content.

##### File Structure and Internal Relationships
- Each of these modules is implemented as separate Maven projects (noted by the presence of many “pom.xml” files). This means that while they might be conceptually standalone, they share the same repository and are all “modules” of the larger series.
- Within modules like design_patterns, the division by category (Creational, Structural, Behavioral) is clearly indicated by directory names. In addition, within these there are further examples (for instance, the structural module contains separate folders for Adapter, Bridge, Composite, etc.).
- Similarly, in the low_level_design part, each design problem is in its own directory reflecting a particular scenario. Some projects even contain multiple Java packages to demonstrate state management, chain-of-responsibility, or other behavioral techniques.

a. Main Components to Capture:
– A high-level “Repository” block representing the Low-Level Design Series.
– Separate blocks (or containers) for each module: OOP, SOLID, Design Patterns, and Low-Level Design.
– For Low-Level Design Problems, consider grouping by type (game designs, system designs, utility systems) or even highlight a few representative examples (like Amazon Locker, TicTacToe, Vending Machine) if a detailed subdiagram is needed.

b. Relationships/Interactions Between Components:
– Annotate any dependencies where one module’s ideas might extend or exemplify concepts from another (for example, the SOLID principles often drive the implementation of the patterns in design_patterns).

c. Architectural Patterns and Design Principles:
– Mention that the repository is organized using modular design principles for separation of concerns. Each module is self-contained with its own configuration (pom.xml), following common practices in Java-based projects.
– Emphasize that for each design pattern, the architecture is demonstrated via sample code organized by package which mirrors the real-world application of the pattern (for example, the Chain of Responsibility is modeled as a series of handler classes).

d. Relevant Technologies and Frameworks:
– Java is the primary programming language.
– Apache Maven is used as the project/build automation tool.

##### Elements
– Clear Labels: Name each module (e.g., “OOP”, “SOLID”, “Design Patterns – Structural”).

## Diagram (Mermaid)

```mermaid
flowchart TD
    A["Low-Level Design Series"]:::repo
    B["OOP Module"]:::module
    C["SOLID Design Principles"]:::module
    D["Design Patterns Module"]:::module
    E["Low-Level Design Problems"]:::module
    F["Java (Primary Programming Language)"]:::tech
    G["Apache Maven (Build Automation)"]:::tech

    A --> B
    A --> C
    A --> D
    A --> E
    A --> F
    A --> G
    C -->|"drives"| D

    %% Design Patterns Submodules
    D --> D1["Creational Patterns"]:::submodule
    D --> D2["Structural Patterns"]:::submodule
    D --> D3["Behavioral Patterns"]:::submodule

    %% Creational Examples
    D1 --> D1a["Singleton"]:::example
    D1 --> D1b["Factory"]:::example

    %% Structural Examples
    D2 --> D2a["Adapter"]:::example
    D2 --> D2b["Decorator"]:::example

    %% Behavioral Examples
    D3 --> D3a["Chain-of-responsibility"]:::example
    D3 --> D3b["Observer"]:::example

    %% Click Events for Component Mapping
    click A "https://github.com/ishan-aggarwal/low_level_design_by_ishan/tree/master/Repository root"
    click B "https://github.com/ishan-aggarwal/low_level_design_by_ishan/tree/master/oop"
    click C "https://github.com/ishan-aggarwal/low_level_design_by_ishan/tree/master/design_principles"
    click D "https://github.com/ishan-aggarwal/low_level_design_by_ishan/tree/master/design_patterns"
    click D1 "https://github.com/ishan-aggarwal/low_level_design_by_ishan/tree/master/design_patterns/creational"
    click D2 "https://github.com/ishan-aggarwal/low_level_design_by_ishan/tree/master/design_patterns/structural"
    click D3 "https://github.com/ishan-aggarwal/low_level_design_by_ishan/tree/master/design_patterns/behavioural"
    click E "https://github.com/ishan-aggarwal/low_level_design_by_ishan/tree/master/low_level_design"

    %% Styles
    classDef repo fill:#FFEEAD,stroke:#333,stroke-width:2px,stroke-dasharray: 5 5;
    classDef module fill:#C1E1FF,stroke:#333,stroke-width:2px;
    classDef submodule fill:#C1FFC1,stroke:#333,stroke-width:2px;
    classDef example fill:#FFD1DC,stroke:#333,stroke-width:1px;
    classDef tech fill:#F0E68C,stroke:#333,stroke-width:2px;
```
