# sharmer156/dialux architecture

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

- Interactive diagram: https://gitdiagram.com/sharmer156/dialux
- Repository: https://github.com/sharmer156/dialux

## Overview

##### Project type and purpose
- This is not a traditional codebase but an open-source resource repository for the DIALux lighting-design software.
- Purpose: to collect and distribute sample files (.dlx, .ies), a mobile APK, images, documentation, and links to courses/plugins.

##### File structure
- Top‐level artifacts:
- DialuxMobile.apk – the DIALux mobile app binary
- dialux-sample-files/ – sample DIALux project files (.dlx)
- ies-sample-files/ – sample photometric IES files and a README
- img/ – supporting images and a readme
- README.md, LICENSE – repository documentation
- No source code or build scripts; it is static content for download/use.
- Directory “file composition” contains its own README (likely describing how files are organized).

##### README for additional insights
- README describes DIALux, how to download the desktop/mobile software, and points to tutorials and plugin info.
- No internal architecture; it serves as a hub for resources.

a. Main components
- Git Repository (GitHub/GitLab/etc.)
- Artifact Storage
– APK (DialuxMobile.apk)
– .dlx sample files (dialux-sample-files/)
– .ies sample files (ies-sample-files/)
– Images (img/)
- Documentation
– README.md at root
– file composition/README.md
– ies-sample-files/readme.markdown
- End Users
– Lighting designers (desktop users)
– Mobile users (install APK)
– Plugin developers (refer to /plugin/README.md)
b. Relationships and interactions
- Users clone or download the Git repo → retrieve artifacts → open in DIALux desktop or mobile
- Documentation guides users how to install or use samples
- Sample files are loaded into DIALux for design and calculation
c. Architectural patterns or design principles
- Static content repository pattern
- Clear separation between asset types (DXL projects vs. IES photometric data vs. images vs. binaries vs. docs)
d. Relevant technologies/frameworks
- Git for version control and distribution
- DIALux Desktop & DIALux Mobile apps for consumption of samples and APK
- Markdown for documentation

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Storage Components
    subgraph "Repository Storage"
        GitRepo["Git Repository (Static Content Hub)"]:::storage
        DXL["Sample DXL Files"]:::artifact
        IES["Photometric IES Files"]:::artifact
        IMG["Images"]:::artifact
        APK["APK Artifact"]:::binary
    end

    %% Documentation
    subgraph "Documentation"
        README["README.md"]:::doc
        LICENSE["LICENSE"]:::doc
        FileCompReadme["file composition/README.md"]:::doc
        IESReadme["ies-sample-files/readme.markdown"]:::doc
        ImgReadme["img/readme.md"]:::doc
    end

    %% Users
    subgraph "End Users"
        DesktopUser["Lighting Designers (Desktop)"]:::user
        MobileUser["Mobile Users (Install APK)"]:::user
        PluginDev["Plugin Developers"]:::user
    end

    %% Data Flow
    GitRepo --> DXL
    GitRepo --> IES
    GitRepo --> IMG
    GitRepo --> APK
    GitRepo --> README
    GitRepo --> LICENSE
    GitRepo --> FileCompReadme
    GitRepo --> IESReadme
    GitRepo --> ImgReadme

    DXL --> DesktopUser
    IES --> DesktopUser
    IMG --> DesktopUser
    APK --> MobileUser

    README --> DesktopUser
    README --> MobileUser
    README --> PluginDev
    FileCompReadme --> DesktopUser
    IESReadme --> DesktopUser
    ImgReadme --> DesktopUser

    %% Click Events
    click GitRepo "https://github.com/sharmer156/dialux/tree/master//"
    click APK "https://github.com/sharmer156/dialux/blob/master//DialuxMobile.apk"
    click DXL "https://github.com/sharmer156/dialux/tree/master//dialux-sample-files/"
    click IES "https://github.com/sharmer156/dialux/tree/master//ies-sample-files/"
    click IMG "https://github.com/sharmer156/dialux/tree/master//img/"
    click README "https://github.com/sharmer156/dialux/blob/master//README.md"
    click LICENSE "https://github.com/sharmer156/dialux/tree/master//LICENSE"
    click FileCompReadme "https://github.com/sharmer156/dialux/blob/master//file composition/README.md"
    click IESReadme "https://github.com/sharmer156/dialux/blob/master//ies-sample-files/readme.markdown"
    click ImgReadme "https://github.com/sharmer156/dialux/blob/master//img/readme.md"

    %% Styles
    classDef storage fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef artifact fill:#90EE90,stroke:#333,stroke-width:1px
    classDef binary fill:#FFA500,stroke:#333,stroke-width:1px
    classDef doc fill:#DDA0DD,stroke:#333,stroke-width:1px
    classDef user fill:#EEEEEE,stroke:#333,stroke-width:1px,stroke-dasharray: 5 5
```
