# hyperbrowserai/examples architecture

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

- Interactive diagram: https://gitdiagram.com/hyperbrowserai/examples
- Repository: https://github.com/hyperbrowserai/examples

## Overview

##### Project type and purpose
- This is a monorepo of small, standalone example apps (“Examples Repository”) demonstrating how to call and use the Hyperbrowser API.
- Each subfolder under the root is an independent script or mini-app (in Node/TypeScript or Python), e.g., “article-tts,” “product-search,” “chat-with-youtube,” “tweet-fetcher,” etc.

##### File structure
- Top-level directories: one folder per example (most with a single `.ts` or `.py` entry point, config files like `package.json` or `pyproject.toml`, and TS or Python dependency files).
- No shared “frontend” or “backend” folders—each example is self-contained.
- Common patterns:
- TypeScript examples (named `.ts`, NodeJS configs)
- Python examples (named `.py`, Streamlit configs in some)
- No monolithic build scripts—each folder installs and runs on its own.

##### README for additional insights
- Confirms the project’s goal: provide usage examples for Hyperbrowser.
- All examples require a Hyperbrowser API key and demonstrate diverse use cases (TTS, scraping, summarization, bots, etc.).

##### Detail
- Config files or auth flows (highlight `package.json` vs. `pyproject.toml`).

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External APIs
    subgraph "External Third-Party APIs"
        direction TB
        YouTube["YouTube Data API"]:::external
        GoogleMaps["Google Maps API"]:::external
        TwitterAPI["Twitter API"]:::external
        GitHubAPI["GitHub API"]:::external
    end

    %% Central Hyperbrowser API
    Hyperbrowser["Hyperbrowser API"]:::api

    %% TypeScript Examples
    subgraph "TS Examples"
        direction TB
        CUA["CUA-CTA-Validator"]:::tsExample
        ChatWebScrape["ChatWithWebsite-Scrape"]:::tsExample
        GitHubSum["GitHub Summarizer"]:::tsExample
        MapsLead["Maps Lead Finder"]:::tsExample
        SEO["SEO Analyzer"]:::tsExample
        TrendSummary["Trend Summary"]:::tsExample
        AGINews["AGI Newsletter"]:::tsExample
        CompanyResearcher["Company Researcher"]:::tsExample
        CompetitorAnalyzer["Competitor Analyzer Bot"]:::tsExample
        CryptoNews["Crypto News Bot"]:::tsExample
        DownDetector["Down Detector Bot"]:::tsExample
        GitHubChatbot["GitHub Chatbot"]:::tsExample
        HBChangelog["HB Changelog Tracker"]:::tsExample
        HBHeaders["HB Headers"]:::tsExample
        HBUiBot["HB UI Bot"]:::tsExample
        O3Extractor["O3 Pro Extractor"]:::tsExample
        ProductSearch["Product Search"]:::tsExample
        RealEstate["Real Estate Finder"]:::tsExample
        VibeBot["Vibe Posting Bot"]:::tsExample
        AGINews -->|click| AGINews
    end

    %% Python Examples
    subgraph "Python Examples"
        direction TB
        BudgetTravel["Budget Travel Agent"]:::pyExample
        ArticleTTS["Article TTS (Streamlit)"]:::pyExample
        ChangelogBuilder["Changelog Builder"]:::pyExample
        ChatYouTube["Chat-with-YouTube"]:::pyExample
        TweetFetcher["Tweet Fetcher"]:::pyExample
        Cookbook["Cookbook"]:::pyExample
    end

    %% Outputs
    ConsoleOut["Console Output"]:::output
    StreamlitUI["Streamlit UI"]:::output

    %% Connectivity to Hyperbrowser API
    CUA -->|REST call + API key| Hyperbrowser
    ChatWebScrape -->|REST call + API key| Hyperbrowser
    GitHubSum -->|REST call + API key| Hyperbrowser
    MapsLead -->|REST call + API key| Hyperbrowser
    SEO -->|REST call + API key| Hyperbrowser
    TrendSummary -->|REST call + API key| Hyperbrowser
    AGINews -->|REST call + API key| Hyperbrowser
    CompanyResearcher -->|REST call + API key| Hyperbrowser
    CompetitorAnalyzer -->|REST call + API key| Hyperbrowser
    CryptoNews -->|REST call + API key| Hyperbrowser
    DownDetector -->|REST call + API key| Hyperbrowser
    GitHubChatbot -->|REST call + API key| Hyperbrowser
    HBChangelog -->|REST call + API key| Hyperbrowser
    HBHeaders -->|REST call + API key| Hyperbrowser
    HBUiBot -->|REST call + API key| Hyperbrowser
    O3Extractor -->|REST call + API key| Hyperbrowser
    ProductSearch -->|REST call + API key| Hyperbrowser
    RealEstate -->|REST call + API key| Hyperbrowser
    VibeBot -->|REST call + API key| Hyperbrowser

    BudgetTravel -->|REST call + API key| Hyperbrowser
    ArticleTTS -->|REST call + API key| Hyperbrowser
    ChangelogBuilder -->|REST call + API key| Hyperbrowser
    ChatYouTube -->|REST call + API key| Hyperbrowser
    TweetFetcher -->|REST call + API key| Hyperbrowser
    Cookbook -->|REST call + API key| Hyperbrowser

    %% External service calls by examples
    ChatWebScrape -->|YouTube Data| YouTubeAPI
    ChatYouTube -->|YouTube Data| YouTubeAPI
    MapsLead -->|Places Lookup| GoogleMaps
    TweetFetcher -->|Fetch Tweets| TwitterAPI
    GitHubSum -->|Repo Data| GitHubAPI
    GitHubChatbot -->|Repo Data| GitHubAPI

    %% Outputs
    CUA -->|outputs to| ConsoleOut
    ChatWebScrape -->|outputs to| ConsoleOut
    GitHubSum -->|outputs to| ConsoleOut
    MapsLead -->|outputs to| ConsoleOut
    SEO -->|outputs to| ConsoleOut
    TrendSummary -->|outputs to| ConsoleOut
    AGINews -->|outputs to| ConsoleOut
    CompanyResearcher -->|outputs to| ConsoleOut
    CompetitorAnalyzer -->|outputs to| ConsoleOut
    CryptoNews -->|outputs to| ConsoleOut
    DownDetector -->|outputs to| ConsoleOut
    GitHubChatbot -->|outputs to| ConsoleOut
    HBChangelog -->|outputs to| ConsoleOut
    HBHeaders -->|outputs to| ConsoleOut
    HBUiBot -->|outputs to| ConsoleOut
    O3Extractor -->|outputs to| ConsoleOut
    ProductSearch -->|outputs to| ConsoleOut
    RealEstate -->|outputs to| ConsoleOut
    VibeBot -->|outputs to| ConsoleOut

    BudgetTravel -->|renders to| StreamlitUI
    ArticleTTS -->|renders to| StreamlitUI
    ChangelogBuilder -->|renders to| StreamlitUI
    ChatYouTube -->|renders to| StreamlitUI
    TweetFetcher -->|renders to| StreamlitUI
    Cookbook -->|renders to| StreamlitUI

    %% Styles
    classDef tsExample fill:#cce5ff,stroke:#333,stroke-width:1px
    classDef pyExample fill:#d4edda,stroke:#333,stroke-width:1px
    classDef api fill:#ffe5b4,stroke:#333,stroke-width:1px
    classDef external fill:#ffdddd,stroke:#333,stroke-width:1px
    classDef output fill:#f0e68c,stroke:#333,stroke-width:1px

    %% Click Events
    click CUA "https://github.com/hyperbrowserai/examples/blob/main/CUA-CTA-Validator/cua-cta-validator.ts"
    click ChatWebScrape "https://github.com/hyperbrowserai/examples/blob/main/ChatWithWebsite-Scrape/scrapechat.ts"
    click GitHubSum "https://github.com/hyperbrowserai/examples/blob/main/Extract-github-analyzer/github-summarizer.ts"
    click MapsLead "https://github.com/hyperbrowserai/examples/blob/main/Maps-lead-finder/maps-lead-finder.ts"
    click SEO "https://github.com/hyperbrowserai/examples/blob/main/SEO-Analyzer/SEO-Analyzer.ts"
    click TrendSummary "https://github.com/hyperbrowserai/examples/blob/main/Trend-summary/TrendSummary.ts"
    click BudgetTravel "https://github.com/hyperbrowserai/examples/blob/main/agents/budget-travel-agent/main.py"
    click AGINews "https://github.com/hyperbrowserai/examples/blob/main/agi-newsletter/trend-newsletter.ts"
    click ArticleTTS "https://github.com/hyperbrowserai/examples/blob/main/article-tts/app.py"
    click ChangelogBuilder "https://github.com/hyperbrowserai/examples/blob/main/changelog-builder/main.py"
    click ChatYouTube "https://github.com/hyperbrowserai/examples/blob/main/chat-with/chat-with-youtube/main.py"
    click CompanyResearcher "https://github.com/hyperbrowserai/examples/blob/main/company-researcher/company-researcher.ts"
    click CompetitorAnalyzer "https://github.com/hyperbrowserai/examples/blob/main/competitor-analyzer-bot/competitor-analysis.ts"
    click CryptoNews "https://github.com/hyperbrowserai/examples/blob/main/crypto-news-bot/crypto-news-bot.ts"
    click DownDetector "https://github.com/hyperbrowserai/examples/blob/main/down-detector-bot/down-detector.ts"
    click GitHubChatbot "https://github.com/hyperbrowserai/examples/blob/main/github-chatbot/github-chatbot.ts"
    click HBChangelog "https://github.com/hyperbrowserai/examples/blob/main/hb-changelog-tracker/changelog.ts"
    click HBHeaders "https://github.com/hyperbrowserai/examples/blob/main/hb-headers/headers.ts"
    click HBUiBot "https://github.com/hyperbrowserai/examples/blob/main/hb-ui-bot/hb-ui-bot.ts"
    click O3Extractor "https://github.com/hyperbrowserai/examples/blob/main/o3-pro-extractor/o3-pro-extractor.ts"
    click ProductSearch "https://github.com/hyperbrowserai/examples/blob/main/product-search/src/index.ts"
    click RealEstate "https://github.com/hyperbrowserai/examples/blob/main/real-estate-finder/real-estate-bot.ts"
    click TweetFetcher "https://github.com/hyperbrowserai/examples/blob/main/tweet-fetcher/main.py"
    click VibeBot "https://github.com/hyperbrowserai/examples/blob/main/vibe-posting-bot/vibe-posting-bot.ts"
    click Cookbook "https://github.com/hyperbrowserai/examples/tree/main/cookbook/"
```
