# thesaltree/low-level-design-golang architecture

> Architecture diagram of the GitHub repository thesaltree/low-level-design-golang, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/thesaltree/low-level-design-golang
- Repository: https://github.com/thesaltree/low-level-design-golang

## Overview

##### Project type and purpose
- This is a monorepo of seven self-contained low-level system design examples in Go:
- ATM Machine
- Parking Lot
- Elevator System
- Library Management System
- Vending Machine
- Social Media Platform
- Meeting Scheduler
- Each subfolder implements a classic LLD problem showcasing specific design patterns, concurrency controls, and domain models.

##### File structure
- Top-level directories correspond one-to-one with the seven systems.
- A main.go entry point
- One or more domain/model files describing core entities (e.g., account, card, floor, elevator, book, member, product, user, room).
- Manager or state files encapsulating business logic (e.g., ATM states, parking lot singleton, elevator manager, post manager, meeting scheduler).
- The presence of files named “state.go”, “manager.go”, or “singleton” hints at specific patterns (State, Singleton, Facade, Observer, Chain of Responsibility).

##### README for additional insights
- The README outlines each system’s purpose, features, and key patterns:
- ATM: State, Chain of Responsibility, Template
- Parking Lot: Singleton, Payment Processing
- Elevator: Multi-elevator coordination, concurrency
- Library: Singleton, concurrency control, borrowing history
- Vending Machine: State Pattern, inventory & transaction handling
- Social Media: Facade, concurrency with RWMutex
- Meeting Scheduler: Observer pattern, calendar management

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% ATM Machine Subsystem
    subgraph "ATM Machine"
        direction TB
        CardReader["Card Reader"]:::entity
        StateMachine["State Machine"]:::pattern
        PINValidator["PIN Validator"]:::service
        AccountService["Account Service"]:::service
        CashDispenser["Cash Dispenser"]:::service
    end
    CardReader -->|"insertCard"| StateMachine
    StateMachine -->|"validatePIN"| PINValidator
    PINValidator -->|"authenticate"| AccountService
    AccountService -->|"dispenseCash"| CashDispenser

    %% Parking Lot Subsystem
    subgraph "Parking Lot"
        direction TB
        ParkingLot["ParkingLot (Singleton)"]:::singleton
        Floor["Floor"]:::entity
        ParkingSpot["ParkingSpot"]:::entity
        Vehicle["Vehicle (Subclass)"]:::entity
        Ticketing["Ticketing"]:::service
        PaymentService["Payment Service"]:::service
    end
    ParkingLot -->|"manages"| Floor
    Floor -->|"contains"| ParkingSpot
    ParkingSpot -->|"occupiedBy"| Vehicle
    ParkingLot -->|"issues"| Ticketing
    Ticketing -->|"processPayment"| PaymentService

    %% Elevator System Subsystem
    subgraph "Elevator System"
        direction TB
        Building["Building"]:::entity
        ElevatorManager["Elevator Manager"]:::manager
        ElevatorInstance["Elevator Instance"]:::entity
        HallPanel["Hall Panel"]:::service
        CarPanel["Car Panel"]:::service
        FloorEntity["Floor"]:::entity
    end
    Building -->|"coordinates"| ElevatorManager
    ElevatorManager -->|"controls"| ElevatorInstance
    ElevatorInstance -->|"updates"| CarPanel
    HallPanel -->|"requests"| ElevatorManager
    FloorEntity --> ElevatorManager

    %% Library Management Subsystem
    subgraph "Library Management"
        direction TB
        LibrarySingleton["Library (Singleton)"]:::singleton
        BookCatalog["Book Catalog"]:::entity
        BookItem["Book Item"]:::entity
        MemberService["Member Service"]:::service
        BorrowCoordinator["Borrow/Return Coordinator"]:::manager
    end
    LibrarySingleton -->|"holds"| BookCatalog
    BookCatalog -->|"contains"| BookItem
    MemberService -->|"requestsBorrow"| BorrowCoordinator
    BorrowCoordinator -->|"updates"| LibrarySingleton

    %% Vending Machine Subsystem
    subgraph "Vending Machine"
        direction TB
        InventoryService["Inventory Service"]:::service
        ProductEntity["Product"]:::entity
        StateContext["State Context"]:::pattern
        VendingCore["Vending Core Logic"]:::manager
    end
    VendingCore -->|"checks"| InventoryService
    InventoryService -->|"provides"| ProductEntity
    VendingCore -->|"transitions"| StateContext
    StateContext -->|"dispense"| ProductEntity

    %% Social Media Platform Subsystem
    subgraph "Social Media Platform"
        direction TB
        Facade["Facade / Activity Manager"]:::manager
        UserManager["User Manager"]:::service
        PostManager["Post Manager"]:::service
        NotificationManager["Notification Manager"]:::service
        ActivityFeed["Activity Feed"]:::entity
        UserEntity["User"]:::entity
        PostEntity["Post"]:::entity
        CommentEntity["Comment"]:::entity
        NotificationEntity["Notification"]:::entity
    end
    Facade -->|"managesUsers"| UserManager
    Facade -->|"managesPosts"| PostManager
    Facade -->|"sendsNotifications"| NotificationManager
    UserManager -->|"creates"| UserEntity
    PostManager -->|"creates"| PostEntity
    PostEntity -->|"hasComments"| CommentEntity
    NotificationManager -->|"pushes"| NotificationEntity
    Facade -->|"aggregates"| ActivityFeed

    %% Meeting Scheduler Subsystem
    subgraph "Meeting Scheduler"
        direction TB
        SchedulerCore["Scheduler Core"]:::manager
        RoomCalendar["Room Calendar"]:::service
        RoomEntity["Room"]:::entity
        UserRegistry["User Registry"]:::service
        ObserverNotifier["Observer Notifier"]:::pattern
    end
    SchedulerCore -->|"schedules"| RoomCalendar
    RoomCalendar -->|"tracks"| RoomEntity
    SchedulerCore -->|"registers"| UserRegistry
    SchedulerCore -->|"notifies"| ObserverNotifier

    %% Click Events ATM
    click CardReader "https://github.com/thesaltree/low-level-design-golang/blob/main/atm-machine/atm/card_reader.go"
    click PINValidator "https://github.com/thesaltree/low-level-design-golang/blob/main/atm-machine/atm/insert_pin.go"
    click AccountService "https://github.com/thesaltree/low-level-design-golang/blob/main/atm-machine/atm/Account.go"
    click CashDispenser "https://github.com/thesaltree/low-level-design-golang/blob/main/atm-machine/atm/withdraw.go"
    click StateMachine "https://github.com/thesaltree/low-level-design-golang/blob/main/atm-machine/atm/atm_state.go"

    %% Click Events Parking Lot
    click ParkingLot "https://github.com/thesaltree/low-level-design-golang/blob/main/parking_lot/parking_lot.go"
    click Floor "https://github.com/thesaltree/low-level-design-golang/blob/main/parking_lot/floor.go"
    click ParkingSpot "https://github.com/thesaltree/low-level-design-golang/blob/main/parking_lot/parking_spot.go"
    click Vehicle "https://github.com/thesaltree/low-level-design-golang/blob/main/parking_lot/vehicles/vehicle.go"
    click Ticketing "https://github.com/thesaltree/low-level-design-golang/blob/main/parking_lot/parking_ticket.go"
    click PaymentService "https://github.com/thesaltree/low-level-design-golang/blob/main/parking_lot/payment.go"

    %% Click Events Elevator System
    click Building "https://github.com/thesaltree/low-level-design-golang/blob/main/elevator_system/building.go"
    click ElevatorManager "https://github.com/thesaltree/low-level-design-golang/blob/main/elevator_system/elevatorManager.go"
    click ElevatorInstance "https://github.com/thesaltree/low-level-design-golang/blob/main/elevator_system/elevator.go"
    click HallPanel "https://github.com/thesaltree/low-level-design-golang/blob/main/elevator_system/hall_panel.go"
    click CarPanel "https://github.com/thesaltree/low-level-design-golang/blob/main/elevator_system/elevator_panel.go"
    click FloorEntity "https://github.com/thesaltree/low-level-design-golang/blob/main/elevator_system/floor.go"

    %% Click Events Library Management
    click LibrarySingleton "https://github.com/thesaltree/low-level-design-golang/blob/main/library-management_system/library.go"
    click BookCatalog "https://github.com/thesaltree/low-level-design-golang/blob/main/library-management_system/book.go"
    click BookItem "https://github.com/thesaltree/low-level-design-golang/blob/main/library-management_system/book_item.go"
    click MemberService "https://github.com/thesaltree/low-level-design-golang/blob/main/library-management_system/member.go"
    click BorrowCoordinator "https://github.com/thesaltree/low-level-design-golang/blob/main/library-management_system/library.go"

    %% Click Events Vending Machine
    click InventoryService "https://github.com/thesaltree/low-level-design-golang/blob/main/vending_machine/inventory.go"
    click ProductEntity "https://github.com/thesaltree/low-level-design-golang/blob/main/vending_machine/product.go"
    click StateContext "https://github.com/thesaltree/low-level-design-golang/blob/main/vending_machine/state.go"
    click VendingCore "https://github.com/thesaltree/low-level-design-golang/blob/main/vending_machine/vending_machine.go"

    %% Click Events Social Media
    click Facade "https://github.com/thesaltree/low-level-design-golang/blob/main/social_media_platform/activity_manager.go"
    click UserManager "https://github.com/thesaltree/low-level-design-golang/blob/main/social_media_platform/user_manager.go"
    click UserEntity "https://github.com/thesaltree/low-level-design-golang/blob/main/social_media_platform/user.go"
    click PostManager "https://github.com/thesaltree/low-level-design-golang/blob/main/social_media_platform/post_manager.go"
    click PostEntity "https://github.com/thesaltree/low-level-design-golang/blob/main/social_media_platform/post.go"
    click CommentEntity "https://github.com/thesaltree/low-level-design-golang/blob/main/social_media_platform/comment.go"
    click NotificationManager "https://github.com/thesaltree/low-level-design-golang/blob/main/social_media_platform/notification_manager.go"
    click NotificationEntity "https://github.com/thesaltree/low-level-design-golang/blob/main/social_media_platform/notification.go"

    %% Click Events Meeting Scheduler
    click SchedulerCore "https://github.com/thesaltree/low-level-design-golang/blob/main/meeting_scheduler/MeetingScheduler.go"
    click RoomCalendar "https://github.com/thesaltree/low-level-design-golang/blob/main/meeting_scheduler/calender.go"
    click RoomEntity "https://github.com/thesaltree/low-level-design-golang/blob/main/meeting_scheduler/room.go"
    click UserRegistry "https://github.com/thesaltree/low-level-design-golang/blob/main/meeting_scheduler/user.go"
    click ObserverNotifier "https://github.com/thesaltree/low-level-design-golang/blob/main/meeting_scheduler/meeting.go"

    %% Styles
    classDef entity fill:#f9f,stroke:#333,stroke-width:1px
    classDef service fill:#bbf,stroke:#333,stroke-width:1px
    classDef manager fill:#bfb,stroke:#333,stroke-width:1px
    classDef singleton fill:#ffb,stroke:#333,stroke-width:1px
    classDef pattern fill:#fbf,stroke:#333,stroke-width:1px
```
