# xuej41/nationalbiddersofcanada architecture

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

- Interactive diagram: https://gitdiagram.com/xuej41/nationalbiddersofcanada
- Repository: https://github.com/xuej41/nationalbiddersofcanada

## Overview

##### Main System Components

a) Client-Side (Frontend):
- Next.js Application Layer
- Auth Pages ((auth-pages) directory)
- Admin Interface (/admin directory)
- Public Pages (items, item/[id])
- Components Layer (UI components, forms)

b) Server-Side:
- Next.js API Routes (/api directory)
- Supabase Backend
- Authentication System
- Real-time Database
- WebSocket Connections

c) External Services:
- OpenAI Integration
- Email Service (for verification)

**[Client Tier]**
- ↕️
**[Application Tier]**
- ↕️
**[Data Tier]**

##### Component Relationships to Highlight

a) Authentication Flow:
**User → Auth Pages → Supabase Auth → Protected Routes**

b) Real-time Bidding Flow:
**User → Bidding Form → WebSocket → Supabase → Real-time Updates → All Connected Clients**

##### Specific Implementation Details

Following flows:
- User Authentication Flow
- Bidding Process Flow
- Real-time Updates Flow
- Admin Item Submission Flow

##### Additional Elements

- Security boundaries
- Scalability points

##### Integration points with external services

Remember to:
- Keep the main flows clear and visible
- Relationship between components
- Where state is managed
- Real-time update paths
- Error handling paths

This system design should reflect a modern, real-time auction platform with emphasis on security, scalability, and user experience, while maintaining clarity about how all components interact to create a seamless auction experience.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Client
        FE[Frontend App]
        AC[Auth Components]:::auth
        BF[Bidding Form]:::bidding
        CT[Countdown Timer]:::bidding
        IC[Item Card]:::item
        CI[Chat Interface]:::chat
        SF[Item Submission Form]:::admin
        NB[Navigation Bar]:::ui
    end

    subgraph "API Layer"
        API_BID["/api/bid"]:::api
        API_ITEMS["/api/auction_items"]:::api
        API_PROF["/api/profile"]:::api
        API_AUTH["/api/sign-in"]:::api
        WS[WebSocket Handler]:::websocket
    end

    subgraph "Auth System"
        AP[Auth Pages]:::auth
        ACB[Auth Callback]:::auth
        MW[Middleware]:::security
        SO[Sign Out]:::auth
    end

    subgraph "Protected Routes"
        PA[Protected Area]:::security
        AD[Admin Dashboard]:::admin
    end

    subgraph "Supabase Backend"
        SC[Supabase Client]:::supabase
        SS[Supabase Server]:::supabase
        SA[Supabase Auth]:::supabase
        DB[(PostgreSQL DB)]:::database
        RT[Real-time Subscriptions]:::realtime
    end

    FE --> AC
    FE --> BF
    FE --> CT
    FE --> IC
    FE --> CI
    FE --> SF
    FE --> NB

    BF --> API_BID
    IC --> API_ITEMS
    AC --> API_AUTH
    
    API_BID --> WS
    WS --> RT
    
    AP --> SA
    ACB --> SA
    MW --> SS
    
    API_BID --> SC
    API_ITEMS --> SC
    API_PROF --> SC
    API_AUTH --> SC
    
    SC --> DB
    SS --> DB
    RT --> DB

    %% Click events
    click AP "https://github.com/xuej41/NationalBiddersOfCanada/tree/main/app/(auth-pages)/"
    click ACB "https://github.com/xuej41/NationalBiddersOfCanada/blob/main/app/auth/callback/route.ts"
    click AC "https://github.com/xuej41/NationalBiddersOfCanada/blob/main/components/header-auth.tsx"
    click SO "https://github.com/xuej41/NationalBiddersOfCanada/blob/main/utils/supabase/signOut.ts"
    click BF "https://github.com/xuej41/NationalBiddersOfCanada/blob/main/app/components/BiddingForm.tsx"
    click API_BID "https://github.com/xuej41/NationalBiddersOfCanada/blob/main/app/api/bid/route.ts"
    click CT "https://github.com/xuej41/NationalBiddersOfCanada/blob/main/app/components/CountdownTimer.tsx"
    click CI "https://github.com/xuej41/NationalBiddersOfCanada/blob/main/components/chat-window.tsx"
    click SF "https://github.com/xuej41/NationalBiddersOfCanada/blob/main/app/components/ItemSubmissionForm.tsx"
    click AD "https://github.com/xuej41/NationalBiddersOfCanada/blob/main/app/admin/submit-item/page.tsx"
    click IC "https://github.com/xuej41/NationalBiddersOfCanada/blob/main/app/components/ItemCard.tsx"
    click API_ITEMS "https://github.com/xuej41/NationalBiddersOfCanada/blob/main/app/api/auction_items/route.ts"
    click PA "https://github.com/xuej41/NationalBiddersOfCanada/tree/main/app/protected/"
    click MW "https://github.com/xuej41/NationalBiddersOfCanada/blob/main/middleware.ts"
    click SC "https://github.com/xuej41/NationalBiddersOfCanada/blob/main/utils/supabase/client.ts"
    click SS "https://github.com/xuej41/NationalBiddersOfCanada/blob/main/utils/supabase/server.ts"
    click NB "https://github.com/xuej41/NationalBiddersOfCanada/blob/main/components/navbar.tsx"
    click API_PROF "https://github.com/xuej41/NationalBiddersOfCanada/blob/main/app/api/profile/route.ts"
    click API_AUTH "https://github.com/xuej41/NationalBiddersOfCanada/blob/main/app/api/sign-in/route.ts"

    %% Styles
    classDef auth fill:#9f7aea
    classDef api fill:#48bb78
    classDef websocket fill:#38b2ac
    classDef bidding fill:#4299e1
    classDef item fill:#ed8936
    classDef chat fill:#667eea
    classDef admin fill:#f6ad55
    classDef ui fill:#a0aec0
    classDef security fill:#fc8181
    classDef supabase fill:#805ad5
    classDef database fill:#4a5568
    classDef realtime fill:#38a169

    %% Legend
    subgraph Legend
        L1[Authentication]:::auth
        L2[API Routes]:::api
        L3[WebSocket]:::websocket
        L4[Bidding Components]:::bidding
        L5[Item Components]:::item
        L6[Chat Components]:::chat
        L7[Admin Components]:::admin
        L8[UI Components]:::ui
        L9[Security]:::security
        L10[Supabase]:::supabase
        L11[Database]:::database
        L12[Real-time]:::realtime
    end
```
