# beeman/awesome-atproto architecture

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

- Interactive diagram: https://gitdiagram.com/beeman/awesome-atproto
- Repository: https://github.com/beeman/awesome-atproto

## Overview

##### Project Type Analysis
This is a specialized content aggregation and generation tool that creates a curated list of ATProto-related resources. The project appears to be a Node.js/TypeScript-based static content generator.

##### Main Components

A. Content Source Layer
- Google Sheets Data Source (mentioned in README)
- Markdown Files (README.md, CONTRIBUTING.md)

B. Processing Layer
- Source Parser (source.ts)
- Content Renderer (render.ts)
- Helper Utilities (lib/helpers.ts)
- Type Definitions (lib/types.ts)

C. Output Layer
- Generated README sections
- Markdown Output

**┌─────────────────────┐**
- External Sources  │
- ┌───────────────┐  │
- Google Sheets │  │
- ┘  │
- ┬───────────┘
- ▼
**┌─────────────────────┐**
- Processing Layer   │
- ┌───────────────┐  │
- source.ts   │──┼────┐
- ┘  │    │
- ┌───────────────┐  │    │
- lib/helpers.ts│◄─┼────┤
- ┘  │    │
- ┌───────────────┐  │    │
- lib/types.ts  │◄─┼────┤
- ┘  │    │
- ┌───────────────┐  │    │
- render.ts   │◄─┼────┘
- ┘  │
- ┬───────────┘
- ▼
**┌─────────────────────┐**
- Output Layer      │
- ┌───────────────┐  │
- Generated README│  │
- ┘  │
- ┘

##### Important Elements to Highlight
- The data flow from Google Sheets to final README generation
- The separation between source parsing and rendering
- The supporting TypeScript utilities and types
- The build process managed by configuration files

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef external fill:#d0e8ff,stroke:#333
    classDef processing fill:#d0ffd0,stroke:#333
    classDef output fill:#ffe4d0,stroke:#333
    classDef config fill:#f0f0f0,stroke:#333
    classDef markdown fill:#fff2cc,stroke:#333

    %% External Sources Layer
    subgraph Sources
        GS[Google Sheets]:::external
        MD[("Markdown Files")]:::markdown
    end

    %% Configuration Layer
    subgraph Config
        TS["TypeScript Config"]:::config
        PR["Prettier Config"]:::config
        HK["Husky Hooks"]:::config
    end

    %% Processing Layer
    subgraph Processing
        SP["Source Parser"]:::processing
        CR["Content Renderer"]:::processing
        HU["Helper Utilities"]:::processing
        TD["Type Definitions"]:::processing
    end

    %% Output Layer
    subgraph Output
        GR["Generated README"]:::output
    end

    %% Relationships
    GS --> SP
    MD --> SP
    SP --> CR
    CR --> GR
    HU --> SP
    HU --> CR
    TD --> SP
    TD --> CR
    TS -.-> Processing
    PR -.-> Processing
    HK -.-> Processing

    %% Click Events
    click SP "https://github.com/beeman/awesome-atproto/blob/main/source.ts"
    click CR "https://github.com/beeman/awesome-atproto/blob/main/render.ts"
    click HU "https://github.com/beeman/awesome-atproto/blob/main/lib/helpers.ts"
    click TD "https://github.com/beeman/awesome-atproto/blob/main/lib/types.ts"
    click MD "https://github.com/beeman/awesome-atproto/blob/main/README.md"
    click HK "https://github.com/beeman/awesome-atproto/tree/main/.husky/"
    click TS "https://github.com/beeman/awesome-atproto/blob/main/tsconfig.json"
    click PR "https://github.com/beeman/awesome-atproto/blob/main/.prettierrc"

    %% Legend
    subgraph Legend
        E1["External Sources"]:::external
        P1["Processing Components"]:::processing
        O1["Output Components"]:::output
        C1["Configuration"]:::config
        M1["Markdown"]:::markdown
    end
```
