# p0lish/svelterm architecture

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

- Interactive diagram: https://gitdiagram.com/p0lish/svelterm
- Repository: https://github.com/p0lish/svelterm

## Overview

##### Main Components

A. Frontend Layer (Client-Side)
- Terminal Interface Components
- Main Terminal (Terminal.svelte)
- Terminal Display (TerminalDisplay.svelte)
- Terminal Input (TerminalInput.svelte)
- Caret and Prompt Components
- SCP Database Interface (SCPApp.svelte)
- Content Display Components
- Content Loader
- Word Frequency Analyzer
- Scanlines (Visual Effect)

B. Routing Layer (SvelteKit)
- Main Routes
- Board View ([board])
- Thread View ([board]/[thread])
- SCP Database View (scp-db)

C. API Layer
- 4chan API Integration
- Board Catalog Endpoint
- Thread Endpoint
- Boards List Endpoint

D. Static Data Store
- SCP Foundation Content
- Series Content (1-9)
- Special Categories (archived, decommissioned, etc.)

**[Client Layer]**
- ↕
**[Routing Layer]**
- ↕
**[Data Layer]**

##### Component Relationships

- How the Terminal components interact with both 4chan and SCP content
- Data flow from API endpoints through the routing layer to the display components
- Demonstrate how static SCP data is loaded and processed

##### Key Technical Details

- SvelteKit as the framework
- API integration points with 4chan
- Static file serving for SCP content
- Terminal emulation architecture

##### Implementation Notes

- The terminal-based interface as the primary user interaction method
- The dual nature of the application (4chan browser and SCP database viewer)
- The separation between dynamic (4chan) and static (SCP) content
- The routing structure that handles both content types

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Frontend
        Terminal["Main Terminal"]
        TermDisp["Terminal Display"]
        TermInput["Terminal Input"]
        Caret["Caret"]
        Prompt["Prompt"]
        ContentLoad["Content Loader"]
        WordFreq["Word Frequency Analyzer"]
        Scanlines["Scanlines Effect"]
        SCPApp["SCP Database Interface"]
    end

    subgraph Routes
        BoardView["Board View"]
        ThreadView["Thread View"]
        SCPView["SCP Database View"]
    end

    subgraph API
        BoardCat["/api/4chan/[board]/catalog"]
        ThreadEnd["/api/4chan/[board]/[thread]"]
        BoardsList["/api/4chan/boards"]
        APIUtils["API Utilities"]
    end

    subgraph Commands
        ChanCmds["Channel Commands"]
        DataRetrieval["Data Retrieval"]
    end

    subgraph "Static Data"
        SCPSeries["SCP Series Content"]
        SpecialCat["Special Categories"]
    end

    %% Frontend Relationships
    Terminal --> TermDisp
    Terminal --> TermInput
    TermInput --> Caret
    TermInput --> Prompt
    Terminal --> ContentLoad
    ContentLoad --> WordFreq
    Terminal --> Scanlines
    Terminal --> SCPApp

    %% Route Connections
    Terminal --> BoardView
    Terminal --> ThreadView
    Terminal --> SCPView
    
    %% API Connections
    BoardView --> BoardCat
    ThreadView --> ThreadEnd
    BoardView --> BoardsList
    BoardCat --> APIUtils
    ThreadEnd --> APIUtils
    BoardsList --> APIUtils

    %% Command System
    Terminal --> ChanCmds
    Terminal --> DataRetrieval
    ChanCmds --> APIUtils
    DataRetrieval --> SCPSeries
    DataRetrieval --> SpecialCat

    %% Styling
    classDef frontend fill:#a8d1f0
    classDef route fill:#f9c270
    classDef api fill:#90EE90
    classDef data fill:#DDA0DD
    classDef command fill:#FFB6C1

    class Terminal,TermDisp,TermInput,Caret,Prompt,ContentLoad,WordFreq,Scanlines,SCPApp frontend
    class BoardView,ThreadView,SCPView route
    class BoardCat,ThreadEnd,BoardsList,APIUtils api
    class SCPSeries,SpecialCat data
    class ChanCmds,DataRetrieval command

    %% Click Events
    click Terminal "https://github.com/p0lish/svelterm/blob/main/src/lib/Terminal.svelte"
    click TermDisp "https://github.com/p0lish/svelterm/blob/main/src/lib/TerminalDisplay.svelte"
    click TermInput "https://github.com/p0lish/svelterm/blob/main/src/lib/TerminalInput.svelte"
    click Caret "https://github.com/p0lish/svelterm/blob/main/src/lib/Caret.svelte"
    click Prompt "https://github.com/p0lish/svelterm/blob/main/src/lib/Prompt.svelte"
    click ContentLoad "https://github.com/p0lish/svelterm/blob/main/src/lib/ContentLoader.svelte"
    click WordFreq "https://github.com/p0lish/svelterm/blob/main/src/lib/WordFreq.svelte"
    click Scanlines "https://github.com/p0lish/svelterm/blob/main/src/lib/Scanlines.svelte"
    click SCPApp "https://github.com/p0lish/svelterm/blob/main/src/lib/SCPApp.svelte"
    click BoardView "https://github.com/p0lish/svelterm/blob/main/src/routes/[board]/+page.svelte"
    click ThreadView "https://github.com/p0lish/svelterm/blob/main/src/routes/[board]/[thread]/+page.svelte"
    click SCPView "https://github.com/p0lish/svelterm/blob/main/src/routes/scp-db/+page.svelte"
    click APIUtils "https://github.com/p0lish/svelterm/blob/main/src/utils/4chanCalls.ts"
    click ChanCmds "https://github.com/p0lish/svelterm/blob/main/src/utils/chanCommands.ts"
    click DataRetrieval "https://github.com/p0lish/svelterm/blob/main/src/utils/getData.js"
    click SCPSeries "https://github.com/p0lish/svelterm/blob/main/static/data/content_series-*.json"
    click SpecialCat "https://github.com/p0lish/svelterm/tree/main/static/data"
```
