# dpgalliance/publicgoods-scripts architecture

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

- Interactive diagram: https://gitdiagram.com/dpgalliance/publicgoods-scripts
- Repository: https://github.com/dpgalliance/publicgoods-scripts

## Overview

##### Project type and purpose
- This is a “static‐site generation & automation” toolchain for the Digital Public Goods website, implemented as an NPM‐managed monorepo with multiple “packages” (frontends, utility scripts) plus a separate Java-Maven TestAutomation suite.
- Its purpose is to crawl a WordPress back end, consolidate data, build several React/NextJS front ends (registry, eligibility quiz, map, community page, help center, roadmap), and move the results into the public website repo via CI.

##### File structure
– Top-level elements:
· .github/workflows: CI definitions (auto.yml, feature.yml, test.yml)
· scripts/: bash utilities (static.bash, moveFiles.bash)
· package.json & package-lock.json: root NPM workspace config, listing workspaces
– packages/automation: Node.js data‐consolidation & HTML‐generation scripts
– packages/registry, eligibility, map, community, helpcenter, roadmap: individual front-end apps (React or NextJS) each with their own package.json, src/, public/
– TestAutomation/DPGAUIAutomation: Java Maven project for UI & API tests, Allure reports, testNG.xml
– Typical build outputs under each package’s build or target folder

##### README for additional insights
- Describes an NPM workspace setup (Node 15+), CLI steps (npm i, clone dependent repos, run scripts/static.bash to crawl WP, run Node scripts in packages/automation, build React apps, run scripts/moveFiles.bash)
- Deployment is driven by GitHub Actions on merges or scheduled triggers, and publishes to GitHub Pages of the public website repo

##### Summary advice
– Capture data flow end-to-end, from CMS to user browser
– Distinguish build orchestration (CI) from runtime (static hosting)
– Keep component boundaries clear: automation vs. presentation vs. testing

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% GitHub and CI
    subgraph "GitHub"
        GHRepo["Monorepo (package.json, package-lock.json)"]:::repo
        subgraph "Workflows"
            Auto["auto.yml"]:::repo
            Feature["feature.yml"]:::repo
            TestWF["test.yml"]:::repo
        end
    end
    GHRepo --> CI["GitHub Actions CI"]:::repo
    Auto --> CI
    Feature --> CI
    TestWF --> CI

    %% CI processes
    CI --> Static["scripts/static.bash"]:::process
    CI --> NodeAuto["Node Automation (packages/automation)"]:::process
    CI --> FEBuilds["Front-End Builds"]:::process
    CI --> Move["scripts/moveFiles.bash"]:::process
    CI --> TestSuite["TestAutomation Suite"]:::test
    CI --> Deploy["Deploy to GitHub Pages"]:::process

    %% Static Bash
    click Static "https://github.com/dpgalliance/publicgoods-scripts/blob/main/scripts/static.bash"

    %% Node Automation Package
    subgraph "packages/automation"
        Index["index.js"]:::process
        Consolidate["consolidate_data.js"]:::process
        GenDPGS["generate_dpgs.js"]:::process
        GenNom["generate_nominees.js"]:::process
        Template["registry_template.html"]:::process
    end
    NodeAuto --> Index
    NodeAuto --> Consolidate
    NodeAuto --> GenDPGS
    NodeAuto --> GenNom
    NodeAuto --> Template

    click Index "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/automation/index.js"
    click Consolidate "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/automation/consolidate_data.js"
    click GenDPGS "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/automation/generate_dpgs.js"
    click GenNom "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/automation/generate_nominees.js"
    click Template "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/automation/registry_template.html"

    %% Front-End Builds
    subgraph "Front-End Packages"
        subgraph Registry
            R_pkg["package.json"]:::repo
            R_index["src/index.js"]:::process
            R_css["src/index.css"]:::process
            R_resize["public/ResizeSensor.js"]:::process
            R_sw["src/serviceWorker.js"]:::process
        end
        subgraph Eligibility
            E_pkg["package.json"]:::repo
            E_index["src/index.js"]:::process
            E_css["src/index.css"]:::process
            E_comp["src/components/*.js"]:::process
            E_api["src/api/quizQuestions.js"]:::process
        end
        subgraph Map
            M_pkg["package.json"]:::repo
            M_config["next.config.js"]:::process
            M_pages["pages/*.js"]:::process
            M_comp["components/*.js"]:::process
            M_public["public/*.geojson, *.csv"]:::process
            M_script["scripts/pointToPolygon.js"]:::process
            M_style["styles/global.css"]:::process
        end
        subgraph Community
            C_index["index.js"]:::process
            C_html["index.html"]:::process
        end
        subgraph HelpCenter
            H_index["index.js"]:::process
            H_html["index.html"]:::process
        end
        subgraph Roadmap
            Rm_pkg["package.json"]:::repo
            Rm_index["src/index.js"]:::process
            Rm_css["src/index.css"]:::process
            Rm_comp["src/components/Roadmap.js"]:::process
            Rm_style["src/components/style.css"]:::process
        end
    end
    FEBuilds --> Registry
    FEBuilds --> Eligibility
    FEBuilds --> Map
    FEBuilds --> Community
    FEBuilds --> HelpCenter
    FEBuilds --> Roadmap

    click R_pkg "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/registry/package.json"
    click R_index "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/registry/src/index.js"
    click R_css "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/registry/src/index.css"
    click R_resize "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/registry/public/ResizeSensor.js"
    click R_sw "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/registry/src/serviceWorker.js"

    click E_pkg "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/eligibility/package.json"
    click E_index "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/eligibility/src/index.js"
    click E_css "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/eligibility/src/index.css"
    click E_comp "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/eligibility/src/components/*.js"
    click E_api "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/eligibility/src/api/quizQuestions.js"

    click M_pkg "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/map/package.json"
    click M_config "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/map/next.config.js"
    click M_pages "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/map/pages/_app.js"
    click M_pages "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/map/pages/_document.js"
    click M_pages "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/map/pages/index.js"
    click M_pages "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/map/pages/helper.js"
    click M_comp "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/map/components/*.js"
    click M_public "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/map/public/*.geojson, *.csv"
    click M_script "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/map/scripts/pointToPolygon.js"
    click M_style "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/map/styles/global.css"

    click C_index "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/community/index.js"
    click C_html "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/community/index.html"

    click H_index "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/helpcenter/index.js"
    click H_html "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/helpcenter/index.html"

    click Rm_pkg "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/roadmap/package.json"
    click Rm_index "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/roadmap/src/index.js"
    click Rm_css "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/roadmap/src/index.css"
    click Rm_comp "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/roadmap/src/components/Roadmap.js"
    click Rm_style "https://github.com/dpgalliance/publicgoods-scripts/blob/main/packages/roadmap/src/components/style.css"

    %% Move Files
    click Move "https://github.com/dpgalliance/publicgoods-scripts/blob/main/scripts/moveFiles.bash"

    %% Test Automation Suite
    subgraph "TestAutomation/DPGAUIAutomation"
        Pom["pom.xml"]:::test
        AppJava["src/main/java/org/example/App.java"]:::test
        API_tests["src/test/java/APIScripts/*.java"]:::test
        UI_tests["src/test/java/uiscripts/*.java"]:::test
        Utils["src/test/java/utilities/BrowserConfig.java"]:::test
        TestNG["testNG.xml"]:::test
        Allure["allure-results/"]:::test
    end
    TestSuite --> Pom
    TestSuite --> AppJava
    TestSuite --> API_tests
    TestSuite --> UI_tests
    TestSuite --> Utils
    TestSuite --> TestNG
    TestSuite --> Allure

    click Pom "https://github.com/dpgalliance/publicgoods-scripts/blob/main/TestAutomation/DPGAUIAutomation/pom.xml"
    click AppJava "https://github.com/dpgalliance/publicgoods-scripts/blob/main/TestAutomation/DPGAUIAutomation/src/main/java/org/example/App.java"
    click API_tests "https://github.com/dpgalliance/publicgoods-scripts/blob/main/TestAutomation/DPGAUIAutomation/src/test/java/APIScripts/*.java"
    click UI_tests "https://github.com/dpgalliance/publicgoods-scripts/blob/main/TestAutomation/DPGAUIAutomation/src/test/java/uiscripts/*.java"
    click Utils "https://github.com/dpgalliance/publicgoods-scripts/blob/main/TestAutomation/DPGAUIAutomation/src/test/java/utilities/BrowserConfig.java"
    click TestNG "https://github.com/dpgalliance/publicgoods-scripts/blob/main/TestAutomation/DPGAUIAutomation/testNG.xml"
    click Allure "https://github.com/dpgalliance/publicgoods-scripts/tree/main/TestAutomation/DPGAUIAutomation/allure-results/"

    %% Deploy & Hosting
    Deploy --> Public["publicgoods-website repo"]:::repo
    Public --> User["End User Browser (digitalpublicgoods.net)"]:::external

    classDef repo fill:#D6E4F0,stroke:#3182CE;
    classDef process fill:#E6F4EA,stroke:#2F855A;
    classDef external fill:#FFFAE6,stroke:#D69E2E;
    classDef test fill:#FEEBC8,stroke:#DD6B20,stroke-dasharray: 5 5;
```
