# tinybirdco/mockingbird architecture

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

- Interactive diagram: https://gitdiagram.com/tinybirdco/mockingbird
- Repository: https://github.com/tinybirdco/mockingbird

## Overview

##### Main Components Overview
The system consists of three main applications and one core package:

A. Core Package (packages/mockingbird):
- Main modules:
- Data Generators
- Schema Definitions
- Extended Faker Types
- Core Types/Interfaces

- CLI Application
- Web UI Application
- Documentation Site

##### Component Relationships

A. Core Package Dependencies:
**[Faker.js] ─→ [Core Package]**
**[Core Types] ─→ [Generators]**
**[Schemas] ─→ [Generators]**

B. Application Dependencies:
**[Core Package] ─→ [CLI App]**
**[Core Package] ─→ [Web UI]**
**[Web UI] ─→ [Documentation]**

##### Data Flow Architecture

**[User Input] ─→ [CLI/Web UI] ─→ [Core Generator] ─→ [Destinations]**

##### Specific Component Details

A. Web UI (apps/web):
- Layout Components
- Step Components
- Settings Components
- State Management
- Worker Architecture

B. Core Generator:
- Base Generator
- Specialized Generators
- Schema Definitions
- Extended Faker Types

##### Implementation Details

- TypeScript/JavaScript architecture
- Next.js based web application
- Worker-based data generation
- URL-based configuration sharing
- Plugin-based destination system

##### Recommended Tools
- Lucidchart

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "User Interface Layer"
        CLI["CLI Application"]:::app
        WebUI["Web UI Application"]:::app
        Docs["Documentation Site"]:::app
    end

    subgraph "Core Package"
        Core["Core Package"]:::core
        Types["Core Types/Interfaces"]:::core
        Schemas["Schema Definitions"]:::core
        ExtFaker["Extended Faker Types"]:::core
        BaseGen["Base Generator"]:::generator
    end

    subgraph "Generator Layer"
        DataGen["Data Generators"]:::generator
        Ably["Ably Generator"]:::generator
        Kinesis["AWS Kinesis Generator"]:::generator
        SNS["AWS SNS Generator"]:::generator
        Kafka["Confluent Kafka Generator"]:::generator
        Spanner["Google Spanner Generator"]:::generator
        RabbitMQ["RabbitMQ Generator"]:::generator
        Tinybird["Tinybird Generator"]:::generator
    end

    subgraph "Web UI Components"
        Layout["Layout Components"]:::ui
        Steps["Step Components"]:::ui
        Settings["Settings Components"]:::ui
        State["State Management"]:::ui
        Worker["Worker Architecture"]:::ui
    end

    subgraph "External Services"
        AblyService["Ably"]:::external
        KinesisService["AWS Kinesis"]:::external
        SNSService["AWS SNS"]:::external
        KafkaService["Confluent Kafka"]:::external
        SpannerService["Google Spanner"]:::external
        RabbitMQService["RabbitMQ"]:::external
        TinybirdService["Tinybird"]:::external
    end

    Faker["Faker.js"]:::external

    %% Relationships
    Faker --> Core
    Core --> CLI
    Core --> WebUI
    WebUI --> Docs

    Types --> DataGen
    Schemas --> DataGen
    Core --> BaseGen
    BaseGen --> DataGen

    DataGen --> Ably
    DataGen --> Kinesis
    DataGen --> SNS
    DataGen --> Kafka
    DataGen --> Spanner
    DataGen --> RabbitMQ
    DataGen --> Tinybird

    Ably --> AblyService
    Kinesis --> KinesisService
    SNS --> SNSService
    Kafka --> KafkaService
    Spanner --> SpannerService
    RabbitMQ --> RabbitMQService
    Tinybird --> TinybirdService

    WebUI --> Layout
    WebUI --> Steps
    WebUI --> Settings
    WebUI --> State
    WebUI --> Worker

    %% Click Events
    click Core "https://github.com/tinybirdco/mockingbird/tree/main/packages/mockingbird/src"
    click DataGen "https://github.com/tinybirdco/mockingbird/tree/main/packages/mockingbird/src/generators"
    click Schemas "https://github.com/tinybirdco/mockingbird/tree/main/packages/mockingbird/src/schemas"
    click ExtFaker "https://github.com/tinybirdco/mockingbird/blob/main/packages/mockingbird/src/extendedFaker.ts"
    click Types "https://github.com/tinybirdco/mockingbird/blob/main/packages/mockingbird/src/types.ts"
    click CLI "https://github.com/tinybirdco/mockingbird/tree/main/apps/cli"
    click WebUI "https://github.com/tinybirdco/mockingbird/tree/main/apps/web"
    click Docs "https://github.com/tinybirdco/mockingbird/tree/main/apps/docs"
    click Ably "https://github.com/tinybirdco/mockingbird/blob/main/packages/mockingbird/src/generators/AblyGenerator.ts"
    click Kinesis "https://github.com/tinybirdco/mockingbird/blob/main/packages/mockingbird/src/generators/AWSKinesisGenerator.ts"
    click SNS "https://github.com/tinybirdco/mockingbird/blob/main/packages/mockingbird/src/generators/AWSSNSGenerator.ts"
    click Kafka "https://github.com/tinybirdco/mockingbird/blob/main/packages/mockingbird/src/generators/ConfluentCloudKafkaGenerator.ts"
    click Spanner "https://github.com/tinybirdco/mockingbird/blob/main/packages/mockingbird/src/generators/GoogleSpannerGenerator.ts"
    click RabbitMQ "https://github.com/tinybirdco/mockingbird/blob/main/packages/mockingbird/src/generators/RabbitMQGenerator.ts"
    click Tinybird "https://github.com/tinybirdco/mockingbird/blob/main/packages/mockingbird/src/generators/TinybirdGenerator.ts"
    click Layout "https://github.com/tinybirdco/mockingbird/blob/main/apps/web/src/components/Layout.tsx"
    click Steps "https://github.com/tinybirdco/mockingbird/tree/main/apps/web/src/components/steps"
    click Settings "https://github.com/tinybirdco/mockingbird/tree/main/apps/web/src/components/settings"
    click State "https://github.com/tinybirdco/mockingbird/blob/main/apps/web/src/lib/state.ts"
    click Worker "https://github.com/tinybirdco/mockingbird/blob/main/apps/web/src/lib/worker.ts"
    click BaseGen "https://github.com/tinybirdco/mockingbird/blob/main/packages/mockingbird/src/generators/BaseGenerator.ts"

    %% Styles
    classDef core fill:#2196F3,stroke:#1565C0,color:white
    classDef app fill:#4CAF50,stroke:#2E7D32,color:white
    classDef generator fill:#9C27B0,stroke:#6A1B9A,color:white
    classDef external fill:#FF9800,stroke:#EF6C00,color:white
    classDef ui fill:#E91E63,stroke:#C2185B,color:white
```
