# zkarimi22/multi-model architecture

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

- Interactive diagram: https://gitdiagram.com/zkarimi22/multi-model
- Repository: https://github.com/zkarimi22/multi-model

## Overview

##### Project Type & Purpose
- This is a **full-stack web application** built on Next.js 15 (App Router) that streams and displays side-by-side AI model responses.
- It includes both client-side UI and server-side API routes for proxying requests to OpenAI and OpenRouter.

##### File Structure
- **src/app**
– `page.tsx`, `layout.tsx`, `globals.css`: entry points for pages & global styling
– **api/models/route.ts**: serverless API route that orchestrates model calls
- **src/components**
– `layout/`: header, footer
– `open-mode/`: UI modal for entering custom API keys
– `ui/`: buttons, cards, dialogs, inputs, theme toggle, toast notifications
- **src/hooks**
– `useChat.ts`: client hook to manage chat state & streaming
– `useOpenRouter.ts`: hook for interacting with OpenRouter endpoints
- **src/providers**
– `theme-provider.tsx`: context for light/dark mode
- **src/lib/utils.ts**, **src/config/models.ts**, **src/types/index.ts**: shared utilities, type definitions
- **Public & Config Files**
– `public/`: static assets and Open Graph image
– Tailwind, ESLint, Next.js config files

##### README for Tech Stack & Features
- Next.js 15 (App Router) + TypeScript
- Tailwind CSS + Radix UI primitives
- OpenAI SDK & OpenRouter API for streaming AI responses
- “Open Mode” allows injecting your own API key

##### Main Components & Their Relationships
A. Client Browser (React on Next.js)
– Renders UI components, layouts, theme toggle
– Uses `useChat` & `useOpenRouter` hooks to open WebSocket or HTTP streams
B. Next.js Server (App Router + API Routes)
– **SSR / SSG** for initial page load via `page.tsx`
– **API Route** at `/api/models` that accepts prompts & model selections, then forwards requests
– Streams AI responses back to the client
C. External AI Services
– **OpenAI** (via their SDK)
– **OpenRouter** (via REST endpoints)
D. CDN / Static Assets
– Served from `public/` via Next.js’ static file handling
E. (Optional) Monitoring / Logging / Analytics
– Not present now, but leave room for future observability components

##### Architectural Patterns & Design Principles
- **Separation of Concerns**: clear split between UI, state management (hooks), business logic (API routes), and utilities.
- **Serverless Functions**: each file in `src/app/api` becomes a serverless endpoint (e.g., Vercel, Netlify).
- **Streaming Data Flow**: responses from AI providers are piped through streams to the browser, enabling real-time comparison.
- **Component-Driven UI**: Radix + Tailwind for reusable, accessible building blocks.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% UI Layer
    subgraph "UI Layer"
        direction TB
        Browser["Browser (React UI)"]:::frontend
        page["page.tsx"]:::frontend
        layout["layout.tsx"]:::frontend
        globals["globals.css"]:::frontend
        header["Header Component"]:::frontend
        footer["Footer Component"]:::frontend
        apiModal["ApiKeyModal"]:::frontend
        btn["Button"]:::frontend
        card["Card"]:::frontend
        dialog["Dialog"]:::frontend
        input["Input"]:::frontend
        toggle["ThemeToggle"]:::frontend
        toast["Toast"]:::frontend
        chatHook["useChat Hook"]:::frontend
        openRouterHook["useOpenRouter Hook"]:::frontend
        themeProvider["ThemeProvider"]:::frontend
        utils["Utils"]:::frontend
        configModels["Model Config"]:::frontend
        types["Type Definitions"]:::frontend
    end

    %% API Layer
    subgraph "API Layer"
        direction TB
        apiModels["/api/models (route.ts)"]:::api
    end

    %% Service Layer
    subgraph "Service Layer"
        direction TB
        openai["OpenAI Service"]:::service
        openrouter["OpenRouter Service"]:::service
    end

    %% Infrastructure Layer
    subgraph "Infrastructure"
        direction TB
        public["Static Assets (public/)"]:::infra
        configs["Config Files"]:::infra
    end

    %% Data Flows
    Browser -->|"SSR GET /"| page
    page --> layout
    layout --> globals
    Browser -->|"uses"| header
    Browser --> footer
    Browser --> apiModal
    Browser --> btn
    Browser --> card
    Browser --> dialog
    Browser --> input
    Browser --> toggle
    Browser --> toast
    Browser --> themeProvider
    Browser --> utils
    Browser --> configModels
    Browser --> types

    Browser -->|"invoke"| chatHook
    Browser -->|"invoke"| openRouterHook

    chatHook -->|"fetch POST /api/models"| apiModels
    openRouterHook --> apiModels

    apiModels -->|"SDK Stream"| openai
    apiModels -->|"REST Stream"| openrouter
    openai -->|"stream response"| apiModels
    openrouter -->|"stream response"| apiModels
    apiModels -->|"SSE stream"| chatHook
    apiModels --> chatHook

    Browser --> public
    Browser --> configs

    %% Click Events
    click page "https://github.com/zkarimi22/multi-model/blob/master/src/app/page.tsx"
    click layout "https://github.com/zkarimi22/multi-model/blob/master/src/app/layout.tsx"
    click globals "https://github.com/zkarimi22/multi-model/blob/master/src/app/globals.css"
    click header "https://github.com/zkarimi22/multi-model/blob/master/src/components/layout/header.tsx"
    click footer "https://github.com/zkarimi22/multi-model/blob/master/src/components/layout/footer.tsx"
    click apiModal "https://github.com/zkarimi22/multi-model/blob/master/src/components/open-mode/ApiKeyModal.tsx"
    click btn "https://github.com/zkarimi22/multi-model/blob/master/src/components/ui/button.tsx"
    click card "https://github.com/zkarimi22/multi-model/blob/master/src/components/ui/card.tsx"
    click dialog "https://github.com/zkarimi22/multi-model/blob/master/src/components/ui/dialog.tsx"
    click input "https://github.com/zkarimi22/multi-model/blob/master/src/components/ui/input.tsx"
    click toggle "https://github.com/zkarimi22/multi-model/blob/master/src/components/ui/theme-toggle.tsx"
    click toast "https://github.com/zkarimi22/multi-model/blob/master/src/components/ui/use-toast.tsx"
    click chatHook "https://github.com/zkarimi22/multi-model/blob/master/src/hooks/useChat.ts"
    click openRouterHook "https://github.com/zkarimi22/multi-model/blob/master/src/hooks/useOpenRouter.ts"
    click themeProvider "https://github.com/zkarimi22/multi-model/blob/master/src/providers/theme-provider.tsx"
    click utils "https://github.com/zkarimi22/multi-model/blob/master/src/lib/utils.ts"
    click configModels "https://github.com/zkarimi22/multi-model/blob/master/src/config/models.ts"
    click types "https://github.com/zkarimi22/multi-model/blob/master/src/types/index.ts"
    click apiModels "https://github.com/zkarimi22/multi-model/blob/master/src/app/api/models/route.ts"

    %% Styles
    classDef frontend fill:#cce5ff,stroke:#0366d6,color:#0366d6
    classDef api fill:#ccffcc,stroke:#22863a,color:#22863a
    classDef service fill:#ffe5cc,stroke:#d18616,color:#d18616
    classDef infra fill:#e0e0e0,stroke:#6a737d,color:#6a737d
```
