Microsoft-Rewards-Bot/src/dashboard/README.md

Dashboard - Modern Real-Time Interface

🎨 New Features (2025 Update - November)

✨ Modern UI Enhancements v2.0

• Professional Dark Theme: Default dark mode with improved color palette and contrast
• Refined Design System: Consistent spacing, typography, and component styling
• Improved Animations: Smoother transitions with optimized performance
• Enhanced Glassmorphism: Better backdrop blur and shadow layering
• Staggered Card Entrance: Beautiful loading animations for stats cards
• Better Visual Hierarchy: Improved text sizing and weight differentiation
• Refined Components: Polished buttons, badges, and interactive elements
• Optimized Icons: Gradient overlays with better sizing

Previous v1.0 Features

• Dark Mode Support: Toggle between light and dark themes with persistent preference
• Real-Time Updates: WebSocket-powered live log streaming and status updates
• Glassmorphism Design: Modern blur effects and smooth animations
• Responsive Layout: Optimized for desktop, tablet, and mobile devices
• Enhanced Stats Cards: Animated counters with gradient icons
• Log Statistics: Real-time error and warning counters

🚀 Performance Improvements

• Optimized Log Management: Maximum 200 logs in memory with automatic cleanup
• Smart WebSocket Reconnection: Automatic reconnection on network failures
• Reduced Bundle Size: Removed unused console.log calls (-15% size)
• Better Error Handling: Comprehensive validation and user-friendly error messages

🔧 Technical Enhancements

• Proper Log Interception: Fixed "No logs yet..." issue by intercepting at module level
• Type-Safe API: Full TypeScript support with proper error handling
• Consistent Logging: All console.log calls replaced with structured logging
• Memory Management: Automatic cleanup of old WebSocket buffers

---

📊 Dashboard UI

Control Panel

• Start/Stop/Restart Bot: Full bot lifecycle management
• Refresh Data: Manual data synchronization
• Clear Logs: Reset log history

Real-Time Monitoring

• Live Logs: Color-coded logs with timestamps, platform tags, and titles
• Account Status: Per-account progress with points tracking
• Statistics Dashboard: Total accounts, points, completed runs, errors

Theme Support

• Light Mode: Clean white interface with subtle shadows
• Dark Mode: Eye-friendly dark interface for night work

---

API Endpoints

Status & Control

GET /api/status

Get current bot status.

Response:

{
  "running": false,
  "lastRun": "2025-11-03T10:30:00.000Z",
  "currentAccount": "user@example.com",
  "totalAccounts": 5
}

POST /api/start

Start bot execution in background.

Response:

{
  "success": true,
  "pid": 12345
}

POST /api/stop

Stop bot execution.

Response:

{
  "success": true
}

---

Accounts

GET /api/accounts

List all accounts with masked emails and status.

Response:

[
  {
    "email": "user@example.com",
    "maskedEmail": "u***@e***.com",
    "points": 5420,
    "lastSync": "2025-11-03T10:30:00.000Z",
    "status": "completed",
    "errors": []
  }
]

POST /api/sync/:email

Force synchronization for a single account.

Parameters:

• email (path): Account email

Response:

{
  "success": true,
  "pid": 12346
}

---

Logs & History

GET /api/logs?limit=100

Get recent logs.

Query Parameters:

• limit (optional): Max number of logs (default: 100, max: 500)

Response:

[
  {
    "timestamp": "2025-11-03T10:30:00.000Z",
    "level": "log",
    "platform": "DESKTOP",
    "title": "SEARCH",
    "message": "Completed 30 searches"
  }
]

DELETE /api/logs

Clear all logs from memory.

Response:

{
  "success": true
}

GET /api/history

Get recent run summaries (last 7 days).

Response:

[
  {
    "runId": "abc123",
    "timestamp": "2025-11-03T10:00:00.000Z",
    "totals": {
      "totalCollected": 450,
      "totalAccounts": 5,
      "accountsWithErrors": 0
    },
    "perAccount": [...]
  }
]

---

Configuration

GET /api/config

Get current configuration (sensitive data masked).

Response:

{
  "baseURL": "https://rewards.bing.com",
  "headless": true,
  "clusters": 2,
  "webhook": {
    "enabled": true,
    "url": "htt***://dis***"
  }
}

POST /api/config

Update configuration (creates automatic backup).

Request Body: Full config object

Response:

{
  "success": true,
  "backup": "/path/to/config.jsonc.backup.1730634000000"
}

---

Metrics

GET /api/metrics

Get aggregated metrics.

Response:

{
  "totalAccounts": 5,
  "totalPoints": 27100,
  "accountsWithErrors": 0,
  "accountsRunning": 0,
  "accountsCompleted": 5
}

---

WebSocket

Connect to ws://localhost:3000/ws for real-time log streaming.

Message Format:

{
  "type": "log",
  "log": {
    "timestamp": "2025-11-03T10:30:00.000Z",
    "level": "log",
    "platform": "DESKTOP",
    "title": "SEARCH",
    "message": "Completed search"
  }
}

On Connect: Receives history of last 50 logs:

{
  "type": "history",
  "logs": [...]
}

---

Usage

Start Dashboard

npm run dashboard
# or in dev mode
npm run dashboard-dev

Default: http://127.0.0.1:3000

Environment Variables

• DASHBOARD_PORT: Port number (default: 3000)
• DASHBOARD_HOST: Bind address (default: 127.0.0.1)

Security

• Localhost only: Dashboard binds to 127.0.0.1 by default
• Email masking: Emails are partially masked in API responses
• Token masking: Webhook URLs and auth tokens are masked
• Config backup: Automatic backup before any config modification

---

Example Usage

Check Status

curl http://localhost:3000/api/status

Start Bot

curl -X POST http://localhost:3000/api/start

Get Logs

curl http://localhost:3000/api/logs?limit=50

Sync Single Account

curl -X POST http://localhost:3000/api/sync/user@example.com