# speedyapply/2025-swe-college-jobs architecture

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

- Interactive diagram: https://gitdiagram.com/speedyapply/2025-swe-college-jobs
- Repository: https://github.com/speedyapply/2025-swe-college-jobs

## Overview

##### Major components
- Repository & Version Control: This is the GitHub repo that houses the static markdown content (README.md, INTERN_INTL.md, NEW_GRAD_INTL.md, NEW_GRAD_USA.md).
- GitHub Workflows (CI/CD): Under .github/workflows, you have files like “add-or-update-job.yml” and “get-jobs.yml”. Display these as automated pipelines that trigger on schedules or events.
- Update Scripts (Business Logic): Under the .github/scripts directory you find TypeScript source files such as “add-or-update-job.ts” and “get-jobs.ts” along with their related configuration (tsconfig.json) and type definitions (schemas). These scripts are the “engine” that queries external data sources or APIs (for example, the SpeedyApply API behind the “chart” image in the readme) to fetch the latest job postings.
- External Service Integration: Represent external endpoints (e.g. SpeedyApply API for job charts, Discord and Chrome Web Store links) that are integrated into the system. Although the repository itself is static, it embeds real-time data (via images or links) from external sources.
- Contribution Interface: The .github/ISSUE_TEMPLATE provides a structured way for contributors to propose changes or additions. This is a point of input into the system.

##### Relationships and flow
- The Update Scripts then feed into GitHub Workflows (triggered either on a schedule or manual events) that run these Node.js/TypeScript scripts.
- The updated repository content is then rendered via GitHub Pages (or simply as a static site on GitHub), which visitors see as the job board (the content shown in the README and other markdown pages).
- Additionally, contributor inputs are received via the GitHub Issue Templates which feed into the repository and may trigger the workflows to recalculate or update job listings.

##### Important architectural patterns and design principles
- Serverless / Static Site: Emphasize that there is no traditional “backend” service; the entire system relies on the repository and scheduled automation via GitHub Actions.
- CI/CD Pipeline Pattern: The workflow automation acts as the continuous integration and deployment pipeline.
- Modularity & Reusability: The scripts (following a modular TypeScript design) separate concerns such as fetching data (queries.ts and get-jobs.ts), applying mutations (mutations.ts), and defining data schemas.
- Extensibility: The presence of explicit type definitions and separate pages for different job categories indicates that the design can be extended readily to additional job boards or data sources.

##### Relevant technologies and frameworks
- GitHub Actions (for CI/CD automation)
- Node.js/TypeScript (as evidenced by the .ts files and tsconfig.json configuration)
- Markdown for static content (the job board pages and README)
- External hosted services (SpeedyApply for job charts, Discord server, Chrome Web Store integration)
- GitHub Issue Templates (for community contributions)

## Diagram (Mermaid)

```mermaid
graph TD
    %% External Services
    subgraph "External Services"
        API["External APIs & Services"]:::external
    end

    %% Automation Layer
    subgraph "Automation Layer"
        subgraph "Update Engine (TypeScript Scripts)"
            SCRIPTS[".github/scripts (Update Engine)"]:::automation
            S1["add-or-update-job.ts"]:::automationSub
            S2["get-jobs.ts"]:::automationSub
            S3["mutations.ts"]:::automationSub
            S4["queries.ts"]:::automationSub
            S5["tsconfig.json"]:::automationSub
        end
        subgraph "GitHub Workflows (CI/CD Pipeline)"
            WORKFLOWS[".github/workflows (Workflows)"]:::automation
            WF1["add-or-update-job.yml"]:::automationSub
            WF2["get-jobs.yml"]:::automationSub
        end
    end

    %% Content Layer (Static Site)
    subgraph "Content Layer (Static Site)"
        REPO["Repository (Static Content)"]:::content
        M1["README.md"]:::content
        M2["INTERN_INTL.md"]:::content
        M3["NEW_GRAD_INTL.md"]:::content
        M4["NEW_GRAD_USA.md"]:::content
    end

    %% Contribution Interface
    subgraph "Contribution Interface"
        CONTRIBUTION[".github/ISSUE_TEMPLATE (Contribution)"]:::contribution
        CT1["config.yml"]:::contribution
        CT2["new.yml"]:::contribution
        CT3["other.yml"]:::contribution
        CT4["update.yml"]:::contribution
    end

    %% End Users
    USERS["End Users / Job Seekers"]:::content

    %% Data Flow
    API -->|"pulls_data"| SCRIPTS
    SCRIPTS -->|"triggers"| WORKFLOWS
    WORKFLOWS -->|"updates"| REPO
    REPO -->|"renders"| M1
    REPO -->|"renders"| M2
    REPO -->|"renders"| M3
    REPO -->|"renders"| M4
    REPO -->|"delivers"| USERS
    CONTRIBUTION -->|"feeds_updates"| REPO

    %% Internal Structure in Update Engine
    SCRIPTS --> S1
    SCRIPTS --> S2
    SCRIPTS --> S3
    SCRIPTS --> S4
    SCRIPTS --> S5

    %% Internal Structure in GitHub Workflows
    WORKFLOWS --> WF1
    WORKFLOWS --> WF2

    %% Internal Structure in Contribution Interface
    CONTRIBUTION --> CT1
    CONTRIBUTION --> CT2
    CONTRIBUTION --> CT3
    CONTRIBUTION --> CT4

    %% Click Events (using paths from the component mapping)
    click REPO "https://github.com/speedyapply/2025-swe-college-jobs/blob/main/README.md"
    click M1 "https://github.com/speedyapply/2025-swe-college-jobs/blob/main/README.md"
    click M2 "https://github.com/speedyapply/2025-swe-college-jobs/blob/main/INTERN_INTL.md"
    click M3 "https://github.com/speedyapply/2025-swe-college-jobs/blob/main/NEW_GRAD_INTL.md"
    click M4 "https://github.com/speedyapply/2025-swe-college-jobs/blob/main/NEW_GRAD_USA.md"
    click WORKFLOWS "https://github.com/speedyapply/2025-swe-college-jobs/tree/main/.github/workflows"
    click WF1 "https://github.com/speedyapply/2025-swe-college-jobs/blob/main/.github/workflows/add-or-update-job.yml"
    click WF2 "https://github.com/speedyapply/2025-swe-college-jobs/blob/main/.github/workflows/get-jobs.yml"
    click SCRIPTS "https://github.com/speedyapply/2025-swe-college-jobs/tree/main/.github/scripts"
    click S1 "https://github.com/speedyapply/2025-swe-college-jobs/blob/main/.github/scripts/src/add-or-update-job.ts"
    click S2 "https://github.com/speedyapply/2025-swe-college-jobs/blob/main/.github/scripts/src/get-jobs.ts"
    click S3 "https://github.com/speedyapply/2025-swe-college-jobs/blob/main/.github/scripts/src/mutations.ts"
    click S4 "https://github.com/speedyapply/2025-swe-college-jobs/blob/main/.github/scripts/src/queries.ts"
    click S5 "https://github.com/speedyapply/2025-swe-college-jobs/blob/main/.github/scripts/tsconfig.json"
    click CONTRIBUTION "https://github.com/speedyapply/2025-swe-college-jobs/tree/main/.github/ISSUE_TEMPLATE"
    click CT1 "https://github.com/speedyapply/2025-swe-college-jobs/blob/main/.github/ISSUE_TEMPLATE/config.yml"
    click CT2 "https://github.com/speedyapply/2025-swe-college-jobs/blob/main/.github/ISSUE_TEMPLATE/new.yml"
    click CT3 "https://github.com/speedyapply/2025-swe-college-jobs/blob/main/.github/ISSUE_TEMPLATE/other.yml"
    click CT4 "https://github.com/speedyapply/2025-swe-college-jobs/blob/main/.github/ISSUE_TEMPLATE/update.yml"

    %% Styles
    classDef external fill:#f7c6c7,stroke:#333,stroke-width:2px;
    classDef automation fill:#c6e2ff,stroke:#333,stroke-width:2px;
    classDef automationSub fill:#add8e6,stroke:#333,stroke-width:1px;
    classDef content fill:#c6ffc6,stroke:#333,stroke-width:2px;
    classDef contribution fill:#ffe6a7,stroke:#333,stroke-width:2px;
```
