# msaroshali/whats-new architecture

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

- Interactive diagram: https://gitdiagram.com/msaroshali/whats-new
- Repository: https://github.com/msaroshali/whats-new

## Overview

##### Project Type and Purpose
- This is a small full-stack web application (“About WhatsNew”) that fetches tweets via the Twitter API and displays them in a browser.
- Backend is written in Java using Javalin. Frontend is plain HTML/CSS/JavaScript (with Bootstrap for styling). A local SQLite database (“news.db”) stores fetched tweets. A Node script lives in resources to interact with the Twitter API.

##### File Structure
- Top-level files:
- pom.xml – Maven build and dependency management
- package.json / package-lock.json – Node dependencies for the tweet-fetch script
- news.db – SQLite database file
- readme.md – project description
- src/main/java/aboutNew:
- controller/TweetController.java – defines REST endpoints for the UI to fetch tweets
- dao/TweetDAO.java – data access layer interacting with the database
- db/Database.java & SetupDB.java – database connection and initialization (likely creates tables if missing)
- model/Tweet.java – domain model for a Tweet
- Find.java & Obtainer.java – core logic for orchestrating tweet collection (calls Node script or Javalin routes?)
- src/main/resources:
- node/simpleGetTweetScript.js – Node.js script that calls the Twitter API
- public/index.html, .css, .js – static assets served to the browser (UI layout, styling, client-side logic)

##### Extract Insights from README
- The app’s flow: client → Javalin endpoints → DAO → SQLite, plus a separate Node-based fetcher for Twitter.
- Future enhancement: AI summarization, but not yet implemented.

##### Components
a. Frontend (Browser)
– Static assets (index.html, CSS, JS) served by Javalin’s static file handler
– UI logic invokes Java API endpoints for fetching stored tweets or triggering a fetch
b. Javalin Web Server (Java)
– HTTP Layer: TweetController (REST endpoints, routing)
– Service/Orchestrator: Find and Obtainer classes that coordinate fetch operations
– DAO Layer: TweetDAO performs CRUD operations on SQLite
– DB Setup: SetupDB initializes schema; Database manages the connection pool
c. Database
– SQLite (“news.db”) storing Tweet records
d. External Services
– Twitter API invoked by Node.js script (simpleGetTweetScript.js)
– Node.js Runtime invoked either by Java (via ProcessBuilder) or manually to fetch tweets
e. Build & Deployment Tools
– Maven (pom.xml) builds and packages the Javalin server
– npm (package.json) manages Node dependencies for the fetch script

##### Relationships & Data Flows
- User opens browser → loads index.html/css/js from Javalin static folder
- Browser JS calls Javalin REST endpoint “/tweets” → TweetController
- Controller calls DAO → returns Tweet model instances → JSON back to browser
- To refresh data: Controller or a scheduler triggers Obtainer → spawns Node script → Node script calls Twitter API → writes new tweets into SQLite via Database module (through Java or direct DB calls)
- Browser → Javalin (HTTP GET/POST)
- Javalin (Controller) → Service/Obtainer → Node.js script → Twitter API
- Service/Controller → DAO → SQLite
- Browser ← Javalin (JSON response)

##### Architectural Patterns & Design Principles
- Layered architecture (Controller → Service → DAO → Database)
- MVC-like separation: static view assets vs. REST API vs. data persistence
- Script-based integration: Node.js component for external API calls
- Single-process, monolithic deployment (no containerized microservices)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Frontend Layer
    subgraph "Frontend (Browser)"
        direction TB
        Browser["User's Browser"]:::frontend
        Index["index.html"]:::frontend
        CSS1["input.css"]:::frontend
        CSS2["output.css"]:::frontend
        CSS3["style.css"]:::frontend
        JS1["script.js"]:::frontend
        JS2["dark-themeScript.js"]:::frontend
    end

    %% Backend Layer
    subgraph "Javalin Web Server"
        direction TB
        Controller["TweetController"]:::backend
        Service1["Find"]:::backend
        Service2["Obtainer"]:::backend
        DAO["TweetDAO"]:::backend
        DBConn["Database"]:::backend
        DBSchema["SetupDB"]:::backend
        Model["Tweet (Domain Model)"]:::backend
    end

    %% Database
    subgraph "Persistence"
        direction TB
        SQLite[(news.db)]:::database
    end

    %% External Integration
    subgraph "External Integration"
        direction TB
        Script["simpleGetTweetScript.js"]:::external
        TwitterAPI["Twitter API"]:::external
    end

    %% Build & Deployment
    subgraph "Build & Deployment"
        direction TB
        Maven["pom.xml"]:::build
        Npm["package.json\npackage-lock.json"]:::build
    end

    %% Flows
    Browser -->|loads static assets| Index
    Browser -->|loads static assets| CSS1
    Browser -->|loads static assets| CSS2
    Browser -->|loads static assets| CSS3
    Browser -->|loads static assets| JS1
    Browser -->|loads static assets| JS2

    Browser -->|HTTP Request /tweets| Controller
    Controller -->|calls| DAO
    DAO -->|reads/writes| SQLite
    Controller -->|returns JSON| Browser

    Controller -->|orchestrates fetch| Service2
    Service2 -->|invokes| Script
    Script -->|calls| TwitterAPI
    Script -->|inserts tweets| SQLite

    Service2 -->|coordinates| Service1
    Service1 -->|uses| Model

    DBSchema -->|initializes schema| SQLite
    DBConn -->|manages connection| SQLite

    Maven -->|builds| Controller
    Maven -->|builds| Service1
    Maven -->|builds| Service2
    Maven -->|builds| DAO
    Maven -->|builds| DBConn
    Maven -->|builds| DBSchema
    Maven -->|builds| Model

    Npm -->|manages dependencies| Script

    %% Click Events
    click Index "https://github.com/msaroshali/whats-new/blob/master/src/main/resources/public/index.html"
    click CSS1 "https://github.com/msaroshali/whats-new/blob/master/src/main/resources/public/input.css"
    click CSS2 "https://github.com/msaroshali/whats-new/blob/master/src/main/resources/public/output.css"
    click CSS3 "https://github.com/msaroshali/whats-new/blob/master/src/main/resources/public/style.css"
    click JS1 "https://github.com/msaroshali/whats-new/blob/master/src/main/resources/public/script.js"
    click JS2 "https://github.com/msaroshali/whats-new/blob/master/src/main/resources/public/dark-themeScript.js"
    click Controller "https://github.com/msaroshali/whats-new/blob/master/src/main/java/aboutNew/controller/TweetController.java"
    click Service1 "https://github.com/msaroshali/whats-new/blob/master/src/main/java/aboutNew/Find.java"
    click Service2 "https://github.com/msaroshali/whats-new/blob/master/src/main/java/aboutNew/Obtainer.java"
    click DAO "https://github.com/msaroshali/whats-new/blob/master/src/main/java/aboutNew/dao/TweetDAO.java"
    click DBConn "https://github.com/msaroshali/whats-new/blob/master/src/main/java/aboutNew/db/Database.java"
    click DBSchema "https://github.com/msaroshali/whats-new/blob/master/src/main/java/aboutNew/db/SetupDB.java"
    click Model "https://github.com/msaroshali/whats-new/blob/master/src/main/java/aboutNew/model/Tweet.java"
    click Script "https://github.com/msaroshali/whats-new/blob/master/src/main/resources/node/simpleGetTweetScript.js"
    click SQLite "https://github.com/msaroshali/whats-new/blob/master/news.db"
    click Maven "https://github.com/msaroshali/whats-new/blob/master/pom.xml"
    click Npm "https://github.com/msaroshali/whats-new/blob/master/package.json"

    %% Styles
    classDef frontend fill:#D0E8FF,stroke:#0366D6,color:#0366D6
    classDef backend fill:#E2F0D9,stroke:#22863A,color:#22863A
    classDef database fill:#FFE8D0,stroke:#D15704,color:#D15704
    classDef external fill:#FEE2E2,stroke:#D73A49,color:#D73A49
    classDef build fill:#F0F0F0,stroke:#6A737D,color:#6A737D
```
