# paulxv/electron-examples architecture

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

- Interactive diagram: https://gitdiagram.com/paulxv/electron-examples
- Repository: https://github.com/paulxv/electron-examples

## Overview

##### Project type and purpose
- This repo is a collection of Electron JS demo applications (“example-1” through “example-6”) plus a more complete “react-electron” demo.
- Each example illustrates a different Electron feature (simple window, IPC send/receive, fetch API, debugging, custom title bar, embedding a Python Tkinter window).
- The “react-electron” folder is a standalone Electron + React app built with Forge and Webpack, demonstrating a desktop UI composed of React components talking to the Electron main process and external scripts.

##### File structure
Top-level:
- example-1, example-2, …, example-6
– package.json, index.html, main.js (Electron main process), preload.js (secure bridge), renderer.js (UI logic), plus per-example extras (style.css, Python script).
- react-electron
– forge.config.js, webpack.*.config.js (build pipelines)
– package.json
– scripts (shell + Python)
– src/
· main.js (Electron main entry)
· preload.js (IPC bridge)
· renderer.js (renders React root)
· components/*.jsx (React UI)
· index.html, index.css
· scripts/script.py (backend logic)

##### Key insights from README
- The repo is purely demonstration of core Electron architecture and patterns.
- No heavy backend server; examples are standalone desktop apps.
- “react-electron” is the most production-style sample, using Webpack, Forge, React components, and Python integration.

##### Main components
a. Electron Main Process
- Creates BrowserWindow
- Loads index.html or the bundled React app
- Manages lifecycle, menus, debug tools
- Spawns or invokes external scripts (e.g. Python)
b. Preload Script
- Runs in isolated context
- Exposes safe IPC methods (window.api.send, window.api.receive)
c. Renderer Process
- Hosts the HTML/JS UI (plain DOM or React)
- Calls window.api to request data or trigger actions
d. External Services / Scripts
- Python Tkinter window (example-6)
- script.py in react-electron/src/scripts
e. Build Tooling (react-electron only)
- Webpack (main vs. renderer config)
- Forge (packaging, distribution)

##### Relationships and data flow
- Renderer → IPC channel → Main
- Main ↔ External script (spawn or REST call)
- Main → IPC response → Renderer
- In React app: UI event handlers call window.api, update React state, re-render.
- Build tools bundle JS for both main and renderer, apply rules/plugins.

##### Architectural patterns & design principles
- Clear separation of concerns: Main vs. Renderer vs. Preload
- IPC for secure, asynchronous communication
- Module-based React components for UI
- Build pipeline that isolates Node APIs to Main/Preload, prevents direct Node in Renderer
- Single-page renderer (index.html) for each example

##### Essential details to capture
- Differences between examples (e.g., example-3 adds fetch API call directly in Renderer)
- The presence of a secure Preload layer to prevent direct Node in the UI
- In react-electron: two separate Webpack configs (main vs. renderer) and Forge’s role
- The IPC channels used for data exchange in each example

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Example Demos
    subgraph "Example Demos"
        direction TB
        subgraph "Example-1"
            direction TB
            E1_Main["Main Process"]:::node
            E1_Preload["Preload Script"]:::node
            E1_Renderer["Renderer (index.html + renderer.js)"]:::ui
            E1_Renderer -->|"IPC.send(channel,data)"| E1_Main
            E1_Main -->|"IPC.on(channel,callback)"| E1_Renderer
        end
        subgraph "Example-2"
            direction TB
            E2_Main["Main Process"]:::node
            E2_Preload["Preload Script"]:::node
            E2_Renderer["Renderer (index.html + renderer.js)"]:::ui
            E2_Renderer -->|"IPC.send(channel,data)"| E2_Main
            E2_Main -->|"IPC.on(channel,callback)"| E2_Renderer
        end
        subgraph "Example-3"
            direction TB
            E3_Main["Main Process"]:::node
            E3_Preload["Preload Script"]:::node
            E3_Renderer["Renderer (index.html + renderer.js)"]:::ui
            E3_Renderer -->|"IPC.send(channel,data)"| E3_Main
            E3_Main -->|"IPC.on(channel,callback)"| E3_Renderer
        end
        subgraph "Example-4"
            direction TB
            E4_Main["Main Process"]:::node
            E4_Preload["Preload Script"]:::node
            E4_Renderer["Renderer (index.html + renderer.js)"]:::ui
            E4_Renderer -->|"IPC.send(channel,data)"| E4_Main
            E4_Main -->|"IPC.on(channel,callback)"| E4_Renderer
        end
        subgraph "Example-5"
            direction TB
            E5_Main["Main Process"]:::node
            E5_Preload["Preload Script"]:::node
            E5_Renderer["Renderer (index.html + renderer.js)"]:::ui
            E5_Renderer -->|"IPC.send(channel,data)"| E5_Main
            E5_Main -->|"IPC.on(channel,callback)"| E5_Renderer
        end
        subgraph "Example-6"
            direction TB
            E6_Main["Main Process"]:::node
            E6_Preload["Preload Script"]:::node
            E6_Renderer["Renderer (index.html + renderer.js)"]:::ui
            E6_External["Python Tkinter Window"]:::external
            E6_Renderer -->|"IPC.send(channel,data)"| E6_Main
            E6_Main -->|"IPC.on(channel,callback)"| E6_Renderer
            E6_Main -->|"spawn python"| E6_External
            E6_External -->|"stdout"| E6_Main
        end
    end

    %% React-Electron Sample
    subgraph "React-Electron Demo"
        direction TB
        subgraph "Build Tools"
            direction TB
            Forge_Config["Forge Configuration"]:::build
            Webpack_Main["webpack.main.config.js"]:::build
            Webpack_Renderer["webpack.renderer.config.js"]:::build
            Webpack_Rules["webpack.rules.js"]:::build
        end
        Webpack_Main -->|"bundle main process"| RE_Main
        Webpack_Renderer -->|"bundle renderer process"| RE_Renderer
        subgraph "Electron Processes"
            direction TB
            RE_Main["Main Process"]:::node
            RE_Preload["Preload Script"]:::node
            RE_Renderer["Renderer Entry"]:::ui
            RE_Renderer -->|"IPC.send(channel,data)"| RE_Main
            RE_Main -->|"IPC.on(channel,callback)"| RE_Renderer
        end
        subgraph "React Components"
            direction TB
            App["App.jsx"]:::ui
            DataGrid["DataGrid.jsx"]:::ui
            ResBox["ResBox.jsx"]:::ui
            ResContainer["ResBoxContainer.jsx"]:::ui
            Sidebar["Sidebar.jsx"]:::ui
            UpperTabs["UpperTabs.jsx"]:::ui
            App --> DataGrid
            App --> ResContainer
            ResContainer --> ResBox
            App --> Sidebar
            App --> UpperTabs
            RE_Renderer --> App
        end
        subgraph "External Scripts"
            direction TB
            Script1["scripts/script.py"]:::external
            Script2["src/scripts/script.py"]:::external
            RE_Main -->|"spawn python"| Script1
            RE_Main -->|"exec script"| Script2
            Script1 -->|"stdout"| RE_Main
            Script2 -->|"stdout"| RE_Main
        end
    end

    %% Click Events for Example Demos
    click E1_Main "https://github.com/paulxv/electron-examples/blob/main/example-1/main.js"
    click E1_Preload "https://github.com/paulxv/electron-examples/blob/main/example-1/preload.js"
    click E1_Renderer "https://github.com/paulxv/electron-examples/blob/main/example-1/renderer.js"
    click E1_Renderer "https://github.com/paulxv/electron-examples/blob/main/example-1/index.html"
    click E2_Main "https://github.com/paulxv/electron-examples/blob/main/example-2/main.js"
    click E2_Preload "https://github.com/paulxv/electron-examples/blob/main/example-2/preload.js"
    click E2_Renderer "https://github.com/paulxv/electron-examples/blob/main/example-2/renderer.js"
    click E2_Renderer "https://github.com/paulxv/electron-examples/blob/main/example-2/index.html"
    click E3_Main "https://github.com/paulxv/electron-examples/blob/main/example-3/main.js"
    click E3_Preload "https://github.com/paulxv/electron-examples/blob/main/example-3/preload.js"
    click E3_Renderer "https://github.com/paulxv/electron-examples/blob/main/example-3/renderer.js"
    click E3_Renderer "https://github.com/paulxv/electron-examples/blob/main/example-3/index.html"
    click E4_Main "https://github.com/paulxv/electron-examples/blob/main/example-4/main.js"
    click E4_Preload "https://github.com/paulxv/electron-examples/blob/main/example-4/preload.js"
    click E4_Renderer "https://github.com/paulxv/electron-examples/blob/main/example-4/renderer.js"
    click E4_Renderer "https://github.com/paulxv/electron-examples/blob/main/example-4/index.html"
    click E5_Main "https://github.com/paulxv/electron-examples/blob/main/example-5/main.js"
    click E5_Preload "https://github.com/paulxv/electron-examples/blob/main/example-5/preload.js"
    click E5_Renderer "https://github.com/paulxv/electron-examples/blob/main/example-5/renderer.js"
    click E5_Renderer "https://github.com/paulxv/electron-examples/blob/main/example-5/index.html"
    click E6_Main "https://github.com/paulxv/electron-examples/blob/main/example-6/main.js"
    click E6_Preload "https://github.com/paulxv/electron-examples/blob/main/example-6/preload.js"
    click E6_Renderer "https://github.com/paulxv/electron-examples/blob/main/example-6/renderer.js"
    click E6_Renderer "https://github.com/paulxv/electron-examples/blob/main/example-6/index.html"
    click E6_External "https://github.com/paulxv/electron-examples/blob/main/example-6/tk_window.py"

    %% Click Events for React-Electron
    click RE_Main "https://github.com/paulxv/electron-examples/blob/main/react-electron/src/main.js"
    click RE_Preload "https://github.com/paulxv/electron-examples/blob/main/react-electron/src/preload.js"
    click RE_Renderer "https://github.com/paulxv/electron-examples/blob/main/react-electron/src/renderer.js"
    click RE_Renderer "https://github.com/paulxv/electron-examples/blob/main/react-electron/src/index.html"
    click RE_Renderer "https://github.com/paulxv/electron-examples/blob/main/react-electron/src/index.css"
    click App "https://github.com/paulxv/electron-examples/blob/main/react-electron/src/App.jsx"
    click DataGrid "https://github.com/paulxv/electron-examples/blob/main/react-electron/src/components/DataGrid.jsx"
    click ResBox "https://github.com/paulxv/electron-examples/blob/main/react-electron/src/components/ResBox.jsx"
    click ResContainer "https://github.com/paulxv/electron-examples/blob/main/react-electron/src/components/ResBoxContainer.jsx"
    click Sidebar "https://github.com/paulxv/electron-examples/blob/main/react-electron/src/components/Sidebar.jsx"
    click UpperTabs "https://github.com/paulxv/electron-examples/blob/main/react-electron/src/components/UpperTabs.jsx"
    click Script1 "https://github.com/paulxv/electron-examples/blob/main/react-electron/scripts/script.py"
    click Script2 "https://github.com/paulxv/electron-examples/blob/main/react-electron/src/scripts/script.py"
    click Forge_Config "https://github.com/paulxv/electron-examples/blob/main/react-electron/forge.config.js"
    click Webpack_Main "https://github.com/paulxv/electron-examples/blob/main/react-electron/webpack.main.config.js"
    click Webpack_Renderer "https://github.com/paulxv/electron-examples/blob/main/react-electron/webpack.renderer.config.js"
    click Webpack_Rules "https://github.com/paulxv/electron-examples/blob/main/react-electron/webpack.rules.js"

    %% Styles
    classDef node fill:#b6e7a7,stroke:#4f8a10,stroke-width:1px
    classDef ui fill:#aed6f1,stroke:#1b4f72,stroke-width:1px
    classDef external fill:#f9e79f,stroke:#b9770e,stroke-width:1px
    classDef build fill:#d5d8dc,stroke:#566573,stroke-width:1px
```
