# ismouslih/atm architecture

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

- Interactive diagram: https://gitdiagram.com/ismouslih/atm
- Repository: https://github.com/ismouslih/atm

## Overview

##### Project type and purpose
- This is a standalone, command-line ATM Management System written in Node.js.
- It exposes a simple CLI interface for users to authenticate, create accounts, and perform transactions, storing data in JSON files.

##### File structure
Top-level:
- README.md – very brief project description.
- index.js – application entry point, ties together CLI and modules.
- data/ – JSON files (“data.json” and its “copy”) serve as the persistent data store.
- modules/ – business-logic modules organized by feature:
– auth.js – login and credential validation
– createAcc.js – account creation logic
– readline.js – wraps Node’s readline for user I/O
– Transactions/ – subdirectory containing:
- actions.js – deposit/withdraw/balance logic
- Acinfos.js – account-information helpers

##### Key insights from the README
- “ATM Management System” – no higher-level architecture described.
- Implies a single process, in-memory logic, persisted to flat files.

a. Main components:
1. User (CLI)
2. CLI Handler (module: readline.js)
3. Controller Layer (index.js orchestrating commands)
4. Business Logic Modules
- Authentication (modules/auth.js)
- Account Creation (modules/createAcc.js)
- Transaction Processing (modules/Transactions/actions.js & Acinfos.js)
5. Data Store (data/data.json)

b. Component relationships & data flow:
- User → CLI Handler: reads commands and arguments
- CLI Handler → Controller (index.js): passes parsed input
- Controller → Business Modules: invokes
– auth.js to validate users
– createAcc.js to register new accounts
– actions.js / Acinfos.js for deposits, withdrawals, balance queries
- Business Modules ↔ Data Store: read/write JSON files for state persistence
- Controller → CLI Handler → User: outputs results or error messages

c. Architectural patterns & design principles:
- Modular single-process architecture: each feature in its own module
- Separation of concerns: I/O vs. orchestration vs. business logic vs. persistence
- File-based persistence: no external database, simple JSON store

d. Relevant technologies:
- Node.js (runtime)
- built-in ‘readline’ module (wrapped by modules/readline.js)
- JSON file storage

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% UI Layer
    UserTerminal["User (Terminal)"]:::ui
    CLI["Readline Module"]:::ui

    %% Core Controller
    Controller["Index.js (Controller)"]:::core

    %% Business Logic Modules
    subgraph "Business Logic Modules"
        direction TB
        Auth["Auth Module"]:::core
        CreateAcc["CreateAcc Module"]:::core
        Actions["Transactions Actions"]:::core
        AcInfos["Transactions Acinfos"]:::core
    end

    %% Data Store
    subgraph "Data Store"
        direction TB
        Data["data.json (Primary)"]:::data
        Backup["data copy.json (Backup)"]:::data
    end

    %% Project Documentation
    README["README.md"]:::docs

    %% Data Flow
    UserTerminal -->|"enter command"| CLI
    CLI -->|"parse input"| Controller
    Controller -->|"validate user"| Auth
    Controller -->|"create account"| CreateAcc
    Controller -->|"process transaction"| Actions
    Controller -->|"fetch account info"| AcInfos

    Auth <-->|"read/write"| Data
    CreateAcc <-->|"read/write"| Data
    Actions <-->|"read/write"| Data
    AcInfos <-->|"read/write"| Data

    Data --> Backup
    Backup --> Data

    Auth -->|"result"| Controller
    CreateAcc -->|"result"| Controller
    Actions -->|"result"| Controller
    AcInfos -->|"result"| Controller

    Controller -->|"output"| CLI
    CLI -->|"display result"| UserTerminal

    README

    %% Click Events
    click CLI "https://github.com/ismouslih/atm/blob/main/modules/readline.js"
    click Controller "https://github.com/ismouslih/atm/blob/main/index.js"
    click Auth "https://github.com/ismouslih/atm/blob/main/modules/auth.js"
    click CreateAcc "https://github.com/ismouslih/atm/blob/main/modules/createAcc.js"
    click Actions "https://github.com/ismouslih/atm/blob/main/modules/Transactions/actions.js"
    click AcInfos "https://github.com/ismouslih/atm/blob/main/modules/Transactions/Acinfos.js"
    click Data "https://github.com/ismouslih/atm/blob/main/data/data.json"
    click Backup "https://github.com/ismouslih/atm/blob/main/data/data copy.json"
    click README "https://github.com/ismouslih/atm/blob/main/README.md"

    %% Styles
    classDef ui fill:#e0f7e9,stroke:#2e7d32,color:#2e7d32;
    classDef core fill:#e3f2fd,stroke:#1565c0,color:#1565c0;
    classDef data fill:#f5f5f5,stroke:#9e9e9e,color:#616161;
    classDef docs fill:#fff8e1,stroke:#ffb300,color:#ff6f00;
```
