# sarthurx/smorrery-webapp architecture

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

- Interactive diagram: https://gitdiagram.com/sarthurx/smorrery-webapp
- Repository: https://github.com/sarthurx/smorrery-webapp

## Overview

##### Project type and purpose
- This is a single-page web application (SPA) built with Vue.js 3 and Vite.
- Purpose: provide an interactive 3D “orrery” (solar system simulator) with five distinct modules (Education, Events, Lab, Challenge, Tour) that fetch real-time orbital data from NASA APIs and render scenes via WebGL.

##### File structure
- Top-level config and metadata: package.json, vite.config.mjs, .eslintrc.js, .gitignore, README.md.
- public/: static entry point (index.html), fallback pages, bundled scripts/styles/textures for the orrery.
- src/: main application source
- App.vue, main.js – application shell and mount point
- assets/: images, audio, mock_api JSON for local development
- components/: reusable UI components (headers, footers, topic pages)
- pages/: route-level views corresponding to the five modules and other pages
- layouts/: global layout wrappers
- router/: Vue Router configuration
- stores/: Pinia or Vuex state modules (app.js, index.js)
- plugins/: third-party plugin initialization (Vuetify)
- styles/: global SCSS settings
- utils/: two major sub-folders
– APIRequests: abstraction over calls to NASA SBDB/CAD endpoints
– SpaceScene: custom 3D engine scaffolding (core, components, topic controllers)

##### Key architectural insights from README
- Real-time orbital calculations using NASA’s SBDB and CAD APIs.
- Five functional modules, each with its own 3D scene or UI flow.
- Static hosting via GitHub Pages; no server-side code in this repo.

a. Main components
- User’s Browser (Client)
- Vue SPA Container
– Router & Pages (Education, Events, Lab, Challenge, Tour)
– Shared UI Components (headers, nav, footers)
– State Store (Pinia/Vuex)
– Plugins (Vuetify, any others)
- Utilities
– API Layer (utils/APIRequests)
– 3D Engine (utils/SpaceScene: core + components + topic controllers)
- Static Assets
– public/static (scripts, styles, textures)
– src/assets (images, audio, mock_api)
- External Services
– NASA SBDB API
– NASA CAD API
b. Relationships & interactions
- On page navigation, Router loads Pages → uses Components → binds to State Store.
- Page logic calls API Layer → external REST endpoints → data flows into Store.
- 3D Engine reads scene configuration + dynamic data → renders WebGL canvas in Components.
- User actions (mouse, keyboard) feed into 3D Engine controls and Store.
c. Architectural patterns and principles
- Component-based UI (Vue single-file components) – MVVM style
- Client-side routing (Vue Router)
- Centralized state management (Pinia/Vuex)
- Modular utility libraries (clear separation of API logic vs. 3D logic)
- Static-only deployment (no backend code) – progressive enhancement
d. Key technologies
- Vue 3 + Composition API
- Vite (dev server & build)
- Pinia or Vuex for state
- Vue Router
- Vuetify
- WebGL (via Three.js–style abstractions in utils/SpaceScene)
- NASA REST APIs

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% User & Entry
    Browser["Browser"]:::external
    Browser -->|"loads"| AppShell

    %% Vue SPA Shell
    subgraph "Vue SPA"
        direction TB
        AppShell["SPA Shell"]:::ui
        AppShell --> AppVue
        AppShell --> MainJS
        AppVue["App.vue"]:::ui
        MainJS["main.js"]:::ui

        %% Core SPA modules
        AppVue --> Router
        AppVue --> Layout
        AppVue --> Store
        AppVue --> Plugins
        AppVue --> Pages
        AppVue --> Components

        %% Routing and Pages
        Router["Router"]:::logic
        Pages["Pages/Modules"]:::ui
        subgraph "Pages"
            direction TB
            Home["Home"]:::ui
            Education["Education"]:::ui
            Events["Events"]:::ui
            Lab["Lab"]:::ui
            Challenge["Challenge"]:::ui
            Tour["Tour"]:::ui
        end
        Router --> Pages

        %% Layout
        Layout["Default Layout"]:::ui

        %% Shared Components
        Components["Shared UI Components"]:::ui
        subgraph "Components"
            direction TB
            AppHeader["AppHeader"]:::ui
            AppFooter["AppFooter"]:::ui
            AppNav["AppNavigation"]:::ui
            AppLogo["AppHeaderLogo"]:::ui
            HomeLink["HomeModuleLink"]:::ui
            NEOIntro["NEOIntroduction"]:::ui
            NEOTimeline["NEOTimeline"]:::ui
        end

        %% State Store
        Store["State Store"]:::logic
        subgraph "Store"
            direction TB
            StoreIndex["store index"]:::logic
            AppStore["app store"]:::logic
        end
        AppVue --> Store

        %% Plugins
        Plugins["Plugins"]:::logic
        subgraph "Plugins"
            direction TB
            PluginIndex["plugin bootstrap"]:::logic
            VuetifyInit["vuetify init"]:::logic
        end

        %% Services & Utilities
        AppVue --> APILayer
        APILayer["API Layer"]:::logic
        subgraph "API Layer"
            direction TB
            ReqDispatcher["requests.js"]:::logic
            Preprocessor["preprocessor.js"]:::logic
            EventAPI["event.js"]:::logic
        end

        AppVue --> Engine
        Engine["3D Engine"]:::engine
        subgraph "3D Engine"
            direction TB
            %% Entry & Scenes
            SpaceSceneEntry["SpaceScene.js"]:::engine
            EducationScene["EducationScene.js"]:::engine
            EmptyScene["EmptyScene.js"]:::engine

            %% Core Subsystems
            subgraph "Core"
                direction TB
                Resizer["Resizer.js"]:::engine
                Controls["controls.js"]:::engine
                Loop["loop.js"]:::engine
                Renderer["renderer.js"]:::engine
            end

            %% Components
            subgraph "Components"
                direction TB
                Cam["camera.js"]:::engine
                Light["light.js"]:::engine
                Cube["cube.js"]:::engine
                Objects["objects.js"]:::engine
                SceneBuilder["scene.js"]:::engine
                CustomBody["CustomCelestialBody.js"]:::engine
            end

            %% Topics
            subgraph "Topics"
                direction TB
                TopicCtrl["TopicController.js"]:::engine
                Law1["Kepler1stLaw.js"]:::engine
                Law2["Kepler2ndLaw.js"]:::engine
                Law3["Kepler3rdLaw.js"]:::engine
                EmptyTopic["EmptyTopic.js"]:::engine
            end

            %% Utils
            subgraph "Utils"
                direction TB
                Calculator["calculator.js"]:::engine
                Constants["constants.js"]:::engine
            end
        end

        %% Static Assets
        Assets["Static Assets"]:::assets
        subgraph "Assets"
            direction TB
            PublicStatic["public/static"]:::assets
            SrcAssets["src/assets"]:::assets
        end

    end

    %% External Services
    subgraph "External NASA APIs"
        direction TB
        SBDB["NASA SBDB API"]:::external
        CAD["NASA CAD API"]:::external
    end

    %% Data flows
    APILayer -->|requests| SBDB
    APILayer -->|requests| CAD
    SBDB -->|data| APILayer
    CAD -->|data| APILayer

    Engine -->|"renders WebGL"| Browser

    %% Styles
    classDef ui fill:#D0E8FF,stroke:#005B96;
    classDef logic fill:#D6F5D6,stroke:#2E8B57;
    classDef engine fill:#FFD8B1,stroke:#FF8C00;
    classDef assets fill:#F0F0F0,stroke:#A9A9A9;
    classDef external fill:#E4D4F0,stroke:#800080;

    %% Click Events
    click AppVue "https://github.com/sarthurx/smorrery-webapp/blob/main/src/App.vue"
    click MainJS "https://github.com/sarthurx/smorrery-webapp/blob/main/src/main.js"
    click Router "https://github.com/sarthurx/smorrery-webapp/blob/main/src/router/index.js"
    click Home "https://github.com/sarthurx/smorrery-webapp/blob/main/src/pages/index.vue"
    click Education "https://github.com/sarthurx/smorrery-webapp/blob/main/src/pages/education.vue"
    click Events "https://github.com/sarthurx/smorrery-webapp/blob/main/src/pages/events.vue"
    click Lab "https://github.com/sarthurx/smorrery-webapp/blob/main/src/pages/lab.vue"
    click Challenge "https://github.com/sarthurx/smorrery-webapp/blob/main/src/pages/challenge.vue"
    click Tour "https://github.com/sarthurx/smorrery-webapp/blob/main/src/pages/tour.vue"
    click AppHeader "https://github.com/sarthurx/smorrery-webapp/blob/main/src/components/AppHeader.vue"
    click AppFooter "https://github.com/sarthurx/smorrery-webapp/blob/main/src/components/AppFooter.vue"
    click AppNav "https://github.com/sarthurx/smorrery-webapp/blob/main/src/components/AppNavigation.vue"
    click AppLogo "https://github.com/sarthurx/smorrery-webapp/blob/main/src/components/AppHeaderLogo.vue"
    click HomeLink "https://github.com/sarthurx/smorrery-webapp/blob/main/src/components/HomeModuleLink.vue"
    click NEOIntro "https://github.com/sarthurx/smorrery-webapp/blob/main/src/components/NEOIntroduction.vue"
    click NEOTimeline "https://github.com/sarthurx/smorrery-webapp/blob/main/src/components/NEOTimeline.vue"
    click Layout "https://github.com/sarthurx/smorrery-webapp/blob/main/src/layouts/default.vue"
    click StoreIndex "https://github.com/sarthurx/smorrery-webapp/blob/main/src/stores/index.js"
    click AppStore "https://github.com/sarthurx/smorrery-webapp/blob/main/src/stores/app.js"
    click PluginIndex "https://github.com/sarthurx/smorrery-webapp/blob/main/src/plugins/index.js"
    click VuetifyInit "https://github.com/sarthurx/smorrery-webapp/blob/main/src/plugins/vuetify.js"
    click ReqDispatcher "https://github.com/sarthurx/smorrery-webapp/blob/main/src/utils/APIRequests/requests.js"
    click Preprocessor "https://github.com/sarthurx/smorrery-webapp/blob/main/src/utils/APIRequests/preprocessor.js"
    click EventAPI "https://github.com/sarthurx/smorrery-webapp/blob/main/src/utils/APIRequests/apis/event.js"
    click SpaceSceneEntry "https://github.com/sarthurx/smorrery-webapp/blob/main/src/utils/SpaceScene/SpaceScene.js"
    click EducationScene "https://github.com/sarthurx/smorrery-webapp/blob/main/src/utils/SpaceScene/EducationScene.js"
    click EmptyScene "https://github.com/sarthurx/smorrery-webapp/blob/main/src/utils/SpaceScene/EmptyScene.js"
    click Resizer "https://github.com/sarthurx/smorrery-webapp/blob/main/src/utils/SpaceScene/core/Resizer.js"
    click Controls "https://github.com/sarthurx/smorrery-webapp/blob/main/src/utils/SpaceScene/core/controls.js"
    click Loop "https://github.com/sarthurx/smorrery-webapp/blob/main/src/utils/SpaceScene/core/loop.js"
    click Renderer "https://github.com/sarthurx/smorrery-webapp/blob/main/src/utils/SpaceScene/core/renderer.js"
    click Cam "https://github.com/sarthurx/smorrery-webapp/blob/main/src/utils/SpaceScene/components/camera.js"
    click Light "https://github.com/sarthurx/smorrery-webapp/blob/main/src/utils/SpaceScene/components/light.js"
    click Cube "https://github.com/sarthurx/smorrery-webapp/blob/main/src/utils/SpaceScene/components/cube.js"
    click Objects "https://github.com/sarthurx/smorrery-webapp/blob/main/src/utils/SpaceScene/components/objects.js"
    click SceneBuilder "https://github.com/sarthurx/smorrery-webapp/blob/main/src/utils/SpaceScene/components/scene.js"
    click CustomBody "https://github.com/sarthurx/smorrery-webapp/blob/main/src/utils/SpaceScene/components/CustomCelestialBody.js"
    click TopicCtrl "https://github.com/sarthurx/smorrery-webapp/blob/main/src/utils/SpaceScene/topics/TopicController.js"
    click Law1 "https://github.com/sarthurx/smorrery-webapp/blob/main/src/utils/SpaceScene/topics/Kepler1stLaw.js"
    click Law2 "https://github.com/sarthurx/smorrery-webapp/blob/main/src/utils/SpaceScene/topics/Kepler2ndLaw.js"
    click Law3 "https://github.com/sarthurx/smorrery-webapp/blob/main/src/utils/SpaceScene/topics/Kepler3rdLaw.js"
    click EmptyTopic "https://github.com/sarthurx/smorrery-webapp/blob/main/src/utils/SpaceScene/topics/EmptyTopic.js"
    click Calculator "https://github.com/sarthurx/smorrery-webapp/blob/main/src/utils/SpaceScene/utils/calculator.js"
    click Constants "https://github.com/sarthurx/smorrery-webapp/blob/main/src/utils/SpaceScene/utils/constants.js"
    click PublicStatic "https://github.com/sarthurx/smorrery-webapp/tree/main/public/static"
    click SrcAssets "https://github.com/sarthurx/smorrery-webapp/tree/main/src/assets"
```
