frontend/README.md

Frontend - Open LLM Leaderboard 🏆

React interface for exploring and comparing open-source language models.

🏗 Architecture

flowchart TD
    Client(["User Browser"]) --> Components["React Components"]

    subgraph Frontend
        Components --> Context["Context Layer<br>• LeaderboardContext<br>• Global State"]

        API["API Layer<br>• /api/leaderboard/formatted<br>• TanStack Query"] --> |Data Feed| Context

        Context --> Hooks["Hooks Layer<br>• Data Processing<br>• Filtering<br>• Caching"]

        Hooks --> Features["Features<br>• Table Management<br>• Search & Filters<br>• Display Options"]
        Features --> Cache["Cache Layer<br>• LocalStorage<br>• URL State"]
    end

    API --> Backend["Backend Server"]

    style Backend fill:#f96,stroke:#333,stroke-width:2px

✨ Core Features

• 🔍 Search & Filters: Real-time filtering, regex search, advanced filters
• 📊 Data Visualization: Interactive table, customizable columns, sorting
• 🔄 State Management: URL sync, client-side caching (5min TTL)
• 📱 Responsive Design: Mobile-friendly, dark/light themes

🛠 Tech Stack

• React 18 + Material-UI
• TanStack Query & Table
• React Router v6

📁 Project Structure

src/
├── pages/
│   └── LeaderboardPage/
│       ├── components/      # UI Components
│       ├── context/        # Global State
│       └── hooks/          # Data Processing
├── components/             # Shared Components
└── utils/                 # Helper Functions

🚀 Development

# Install dependencies
npm install

# Start development server
npm start

# Production build
npm run build

🔧 Environment Variables

# API Configuration
REACT_APP_API_URL=http://localhost:8000
REACT_APP_CACHE_DURATION=300000  # 5 minutes

🔄 Data Flow

1. API fetches leaderboard data from backend
2. Context stores and manages global state
3. Hooks handle data processing and filtering
4. Components render based on processed data
5. Cache maintains user preferences and URL state