# ahfarmer/calculator architecture

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

- Interactive diagram: https://gitdiagram.com/ahfarmer/calculator
- Repository: https://github.com/ahfarmer/calculator

## Overview

##### Project type and purpose
- This is a single-page frontend application (a calculator) built with React (create-react-app).
- There is no separate backend or external data store—everything runs in the browser.

##### File structure
- Top-level: public/ (static assets & index.html), src/ (React components & logic modules), package.json (dependencies & scripts).
- src/component/: React UI components (App, Display, ButtonPanel, Button).
- src/logic/: pure JS functions handling number checks, operations, and overall calculate logic.
- Tests alongside implementation files in component/ and logic/.

##### README for additional insights
- Confirms React, no mention of server side.
- Deployed as static site (GitHub Pages).

##### Main components
a. Browser / Client (runtime environment)
b. React renderer (ReactDOM)
c. UI Component tree
- App
- Display
- ButtonPanel
- Button
d. Logic modules
- isNumber.js
- operate.js
- calculate.js
e. Build & Deployment
- create-react-app toolchain (Webpack/Babel)
- Static server / GitHub Pages

##### Relationships and interactions
- User clicks a Button → Button onClick handler in ButtonPanel → dispatches an event up to App.
- App invokes calculate(previousState, buttonValue) → internally uses isNumber and operate.
- calculate returns new state → App passes props down to Display → UI re-renders.
- Entire code is bundled by Webpack/Babel at build time and served as static assets.

##### Architectural patterns & design principles
- Component-based UI (React)
- Unidirectional data flow (props down, events up)
- Separation of concerns: UI vs. calculation logic
- Modularity & testability (logic in pure functions, components in isolated files)

##### Technologies, frameworks, libraries
- React, ReactDOM
- create-react-app (Webpack, Babel, ESLint)
- JavaScript ES6 modules
- Jest/React Testing Library for tests
- GitHub Pages (deployment)

##### Elements
- Clear labels: “Browser”, “App Component”, “Display”, “ButtonPanel”, “Button”, “calculate.js”, etc.
- User → Button (click)
- ButtonPanel → App (event)
- App → calculate.js → isNumber/operate → App
- App → Display (props)
- Build Toolchain → bundle → Browser

##### Detailed component breakdown
- Browser/Runtime
- Loads index.html → bundle.js
- Build Pipeline
- create-react-app scripts
- Webpack + Babel transforms src/ → static assets
- React Component Tree
- App.js: root container, holds calculator state
- .js: shows current state (total, next, operation)
- ButtonPanel.js: groups buttons, renders Button components
- Button.js: clickable UI element, forwards value to App
- Logic Layer
- isNumber.js: checks if a value is numeric
- operate.js: basic operations (+, –, ×, ÷, =)
- calculate.js: orchestrates calculator state transitions

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External actor
    User(("User")):::external

    %% Build Pipeline
    subgraph "Build Pipeline"
        Package["package.json"]:::build
        PackageLock["package-lock.json"]:::build
        GitIgnore[".gitignore"]:::build
        Readme["README.md"]:::build
        BuildTools["create-react-app / Webpack + Babel"]:::build
        Package --> BuildTools
        PackageLock --> BuildTools
        GitIgnore --> BuildTools
        Readme --> BuildTools
        BuildTools --> Bundle["bundle.js"]:::build
    end

    %% Public Assets and Runtime
    subgraph "Browser / Runtime"
        IndexHTML["public/index.html"]:::build
        Manifest["public/manifest.json"]:::build
        Browser["Browser"]:::external
        IndexHTML --> Browser
        Manifest --> Browser
        Bundle --> Browser
    end

    %% React entry
    ReactDOM["ReactDOM"]:::ui
    Browser --> ReactDOM
    ReactDOM --> IndexCSS["index.css"]:::build

    %% React Component Tree
    subgraph "React Component Tree"
        App["App Component"]:::ui
        Display["Display Component"]:::ui
        ButtonPanel["ButtonPanel Component"]:::ui
        Button["Button Component"]:::ui
        App --> Display
        App --> ButtonPanel
        ButtonPanel --> Button
    end
    ReactDOM --> App

    %% Logic Modules
    subgraph "Logic Modules"
        Calculate["calculate.js"]:::logic
        CalculateTest["calculate.test.js"]:::logic
        IsNumber["isNumber.js"]:::logic
        Operate["operate.js"]:::logic
        App -->|"calls calculate"| Calculate
        Calculate -->|"uses isNumber"| IsNumber
        Calculate -->|"uses operate"| Operate
        Operate --> Calculate
        IsNumber --> Calculate
        Calculate -->|"returns state"| App
    end

    %% User interaction
    User -->|"click"| Button
    Button -->|"onClick"| App

    %% Click events for file mappings
    click ReactDOM "https://github.com/ahfarmer/calculator/blob/master/src/index.js"
    click IndexCSS "https://github.com/ahfarmer/calculator/blob/master/src/index.css"
    click App "https://github.com/ahfarmer/calculator/blob/master/src/component/App.js"
    click Display "https://github.com/ahfarmer/calculator/blob/master/src/component/Display.js"
    click ButtonPanel "https://github.com/ahfarmer/calculator/blob/master/src/component/ButtonPanel.js"
    click Button "https://github.com/ahfarmer/calculator/blob/master/src/component/Button.js"
    click Calculate "https://github.com/ahfarmer/calculator/blob/master/src/logic/calculate.js"
    click CalculateTest "https://github.com/ahfarmer/calculator/blob/master/src/logic/calculate.test.js"
    click IsNumber "https://github.com/ahfarmer/calculator/blob/master/src/logic/isNumber.js"
    click Operate "https://github.com/ahfarmer/calculator/blob/master/src/logic/operate.js"
    click IndexHTML "https://github.com/ahfarmer/calculator/blob/master/public/index.html"
    click Manifest "https://github.com/ahfarmer/calculator/blob/master/public/manifest.json"
    click Package "https://github.com/ahfarmer/calculator/blob/master/package.json"
    click PackageLock "https://github.com/ahfarmer/calculator/blob/master/package-lock.json"
    click GitIgnore "https://github.com/ahfarmer/calculator/blob/master/.gitignore"
    click Readme "https://github.com/ahfarmer/calculator/blob/master/README.md"

    %% Styles
    classDef ui fill:#ccf,stroke:#333,stroke-width:1px
    classDef logic fill:#cfc,stroke:#333,stroke-width:1px
    classDef build fill:#fcf,stroke:#333,stroke-width:1px
    classDef external fill:#fdd,stroke:#333,stroke-width:1px,stroke-dasharray: 5 5
```
