# quiknode-labs/qn-guide-examples architecture

> Architecture diagram of the GitHub repository quiknode-labs/qn-guide-examples, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/quiknode-labs/qn-guide-examples
- Repository: https://github.com/quiknode-labs/qn-guide-examples

## Overview

##### Project type and purpose
- This is a monorepo (“QuickNode Guide Examples”) containing dozens of independent example applications—front-ends, back-ends, CLI tools, smart‐contract demos, bots and scripts—organized by category: AI, QuickAlerts, Streams, base, defi, bitcoin, ethereum, solana, polygon, stacks, tron, etc.
- Each example illustrates how to integrate with QuickNode’s blockchain-as-a-service endpoints, various SDKs, or external APIs.

##### File structure
- Top-level directories correspond to high-level categories (AI, QuickAlerts, Streams, sample-dapps, etc.).
- Under each category are self-contained subprojects (e.g., “AI/coinbase-ai-agent”, “Streams/dex-metrics-dashboard”, “ethereum/erc-6551”, “solana/explorer-clone-part-1”).
- Typical pattern inside each subproject:
– A package manifest (package.json or analogous)
– Source folder (src or app) containing front-end (React/Next.js/Svelte) code, API routes, CLI scripts or smart-contract configs.
– Config/build artifacts (tsconfig.json, next.config.js, postcss/tailwind configs, hardhat.config.js, foundry.toml).
– Tests or scripts directory.
- There is no single runtime—each module is built and run in isolation, but they share the QuickNode RPC endpoint as the common external service.

##### README for additional insights
- The root README explains that this is a “collection of example applications from QuickNode’s guides” and points contributors to add per-directory README.md.

##### Diagramming recommendations
– Blue rectangles for front-ends
– Green for back-ends / scripts
– Orange for smart-contract components
– Purple for external services

##### Key points to capture in detail
- Monorepo structure with isolated, self-contained example modules
- Shared reliance on QuickNode endpoints and other external APIs
- Variety of technology stacks illustrated by examples
- Clear separation of concerns within each example (UI vs. API vs. contract/test)
- CI/CD or local dev workflows, if present

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Monorepo root and CI/CD
    subgraph "QuickNode Guide Examples (Monorepo)"
        direction TB
        MonorepoRoot["Monorepo Root"] 
        CI["CI/CD Workflows"] 
        subgraph "AI"
            direction TB
            AI1["Coinbase AI Agent<br/>(Node.js)"] 
            AI2["EVM MCP Server<br/>(Python)"] 
        end
        subgraph "QuickAlerts"
            direction TB
            QA1["Telegram Bot<br/>(Node.js)"] 
            QA2["Twitter Bot<br/>(Node.js)"] 
        end
        subgraph "Streams"
            direction TB
            S1["DEX Metrics Dashboard<br/>(React)"] 
            S2["AI Bot Discord<br/>(Node.js)"] 
        end
        subgraph "base"
            direction TB
            B1["Telegram Trading Bot<br/>(Node.js)"] 
        end
        subgraph "console-api"
            direction TB
            C1["Grafana Dashboard<br/>(Docker)"] 
        end
        subgraph "ethereum"
            direction TB
            E1["ERC-6551 Demo<br/>(Hardhat)"] 
            E2["Blink Starter Monad App<br/>(Next.js)"] 
        end
        subgraph "solana"
            direction TB
            SL1["Explorer Clone Part 1<br/>(Svelte)"] 
            SL2["Authentication Demo<br/>(Rust)"] 
        end
        subgraph "polygon"
            direction TB
            P1["ERC721A Implementation<br/>(Hardhat)"] 
        end
        subgraph "sample-dapps"
            direction TB
            D1["AML/CFT-Compliant Dapp<br/>(Next.js+Foundry)"] 
        end
        MonorepoRoot --> CI
    end

    %% External Services
    subgraph "External Services"
        direction TB
        QuickNode["QuickNode RPC API"] 
        TelegramAPI["Telegram Bot API"] 
        TwitterAPI["Twitter API"] 
        Prometheus["Prometheus"] 
        Grafana["Grafana"] 
    end

    %% Connections to QuickNode
    AI1 -->|uses RPC| QuickNode
    AI2 -->|uses RPC| QuickNode
    QA1 -->|uses RPC| QuickNode
    QA2 -->|uses RPC| QuickNode
    S1 -->|uses RPC| QuickNode
    S2 -->|uses RPC| QuickNode
    B1 -->|uses RPC| QuickNode
    C1 -->|scrapes metrics| Prometheus
    C1 -->|visualizes| Grafana
    C1 -->|uses RPC| QuickNode
    E1 -->|deploys to| QuickNode
    E2 -->|uses RPC| QuickNode
    SL1 -->|uses RPC| QuickNode
    SL2 -->|uses RPC| QuickNode
    P1 -->|uses RPC| QuickNode
    D1 -->|uses RPC| QuickNode

    %% Bot integrations
    QA1 -->|sends messages| TelegramAPI
    B1 -->|sends messages| TelegramAPI
    QA2 -->|posts tweets| TwitterAPI
    S2 -->|interacts via| TelegramAPI

    %% CI/CD pipeline
    CI -->|build/test| AI1
    CI -->|build/test| AI2
    CI -->|build/test| QA1
    CI -->|build/test| QA2
    CI -->|build/test| S1
    CI -->|build/test| S2
    CI -->|build/test| B1
    CI -->|build/test| C1
    CI -->|build/test| E1
    CI -->|build/test| E2
    CI -->|build/test| SL1
    CI -->|build/test| SL2
    CI -->|build/test| P1
    CI -->|build/test| D1

    %% Click Events
    click MonorepoRoot "https://github.com/quiknode-labs/qn-guide-examples/tree/main//"
    click AI1 "https://github.com/quiknode-labs/qn-guide-examples/tree/main//AI/coinbase-ai-agent"
    click AI2 "https://github.com/quiknode-labs/qn-guide-examples/tree/main//AI/evm-mcp-server"
    click QA1 "https://github.com/quiknode-labs/qn-guide-examples/tree/main//QuickAlerts/Telegram_bot"
    click QA2 "https://github.com/quiknode-labs/qn-guide-examples/tree/main//QuickAlerts/Twitter_bot"
    click S1 "https://github.com/quiknode-labs/qn-guide-examples/tree/main//Streams/dex-metrics-dashboard"
    click S2 "https://github.com/quiknode-labs/qn-guide-examples/tree/main//Streams/ai-bot-discord"
    click B1 "https://github.com/quiknode-labs/qn-guide-examples/tree/main//base/telegram-trading-bot"
    click C1 "https://github.com/quiknode-labs/qn-guide-examples/tree/main//console-api/grafana-dashboard"
    click E1 "https://github.com/quiknode-labs/qn-guide-examples/tree/main//ethereum/erc-6551"
    click E2 "https://github.com/quiknode-labs/qn-guide-examples/tree/main//ethereum/blink-starter-monad"
    click SL1 "https://github.com/quiknode-labs/qn-guide-examples/tree/main//solana/explorer-clone-part-1"
    click SL2 "https://github.com/quiknode-labs/qn-guide-examples/tree/main//solana/authentication"
    click P1 "https://github.com/quiknode-labs/qn-guide-examples/tree/main//polygon/erc721a-implementation"
    click D1 "https://github.com/quiknode-labs/qn-guide-examples/tree/main//sample-dapps/aml-and-cft-compliant-dapp"
    click CI "https://github.com/quiknode-labs/qn-guide-examples/blob/main//.github"

    %% Styles
    classDef frontend fill:#cce5ff,stroke:#004085,color:#004085;
    classDef backend fill:#d4edda,stroke:#155724,color:#155724;
    classDef contract fill:#fff3cd,stroke:#856404,color:#856404;
    classDef external fill:#e2e3e5,stroke:#6c757d,color:#6c757d;

    class AI1,QA1,QA2,S1,E2,SL1,D1 frontend
    class AI2,S2,B1,C1,E1,SL2,P1 backend
    class E1,P1,SL2 contract
    class QuickNode,TelegramAPI,TwitterAPI,Prometheus,Grafana external
    class CI backend
```
