tfrere commited on
Commit
17aa340
Β·
1 Parent(s): 22c253b

update card

Browse files
Files changed (3) hide show
  1. README.md +3 -3
  2. backend/README.md +0 -0
  3. frontend/README.md +0 -80
README.md CHANGED
@@ -1,11 +1,11 @@
1
  ---
2
- title: Yourbench simple demo
3
- emoji: πŸ†
4
  colorFrom: blue
5
  colorTo: red
6
  sdk: docker
7
  hf_oauth: true
8
  pinned: true
9
  license: apache-2.0
10
- short_description: Yourbench demo
11
  ---
 
1
  ---
2
+ title: Try YourBench!
3
+ emoji: πŸͺ„
4
  colorFrom: blue
5
  colorTo: red
6
  sdk: docker
7
  hf_oauth: true
8
  pinned: true
9
  license: apache-2.0
10
+ short_description: Generate a custom benchmark from any document
11
  ---
backend/README.md DELETED
File without changes
frontend/README.md DELETED
@@ -1,80 +0,0 @@
1
- # Frontend - Open LLM Leaderboard πŸ†
2
-
3
- React interface for exploring and comparing open-source language models.
4
-
5
- ## πŸ— Architecture
6
-
7
- ```mermaid
8
- flowchart TD
9
- Client(["User Browser"]) --> Components["React Components"]
10
-
11
- subgraph Frontend
12
- Components --> Context["Context Layer<br>β€’ LeaderboardContext<br>β€’ Global State"]
13
-
14
- API["API Layer<br>β€’ /api/leaderboard/formatted<br>β€’ TanStack Query"] --> |Data Feed| Context
15
-
16
- Context --> Hooks["Hooks Layer<br>β€’ Data Processing<br>β€’ Filtering<br>β€’ Caching"]
17
-
18
- Hooks --> Features["Features<br>β€’ Table Management<br>β€’ Search & Filters<br>β€’ Display Options"]
19
- Features --> Cache["Cache Layer<br>β€’ LocalStorage<br>β€’ URL State"]
20
- end
21
-
22
- API --> Backend["Backend Server"]
23
-
24
- style Backend fill:#f96,stroke:#333,stroke-width:2px
25
- ```
26
-
27
- ## ✨ Core Features
28
-
29
- - πŸ” **Search & Filters**: Real-time filtering, regex search, advanced filters
30
- - πŸ“Š **Data Visualization**: Interactive table, customizable columns, sorting
31
- - πŸ”„ **State Management**: URL sync, client-side caching (5min TTL)
32
- - πŸ“± **Responsive Design**: Mobile-friendly, dark/light themes
33
-
34
- ## πŸ›  Tech Stack
35
-
36
- - React 18 + Material-UI
37
- - TanStack Query & Table
38
- - React Router v6
39
-
40
- ## πŸ“ Project Structure
41
-
42
- ```
43
- src/
44
- β”œβ”€β”€ pages/
45
- β”‚ └── LeaderboardPage/
46
- β”‚ β”œβ”€β”€ components/ # UI Components
47
- β”‚ β”œβ”€β”€ context/ # Global State
48
- β”‚ └── hooks/ # Data Processing
49
- β”œβ”€β”€ components/ # Shared Components
50
- └── utils/ # Helper Functions
51
- ```
52
-
53
- ## πŸš€ Development
54
-
55
- ```bash
56
- # Install dependencies
57
- npm install
58
-
59
- # Start development server
60
- npm start
61
-
62
- # Production build
63
- npm run build
64
- ```
65
-
66
- ## πŸ”§ Environment Variables
67
-
68
- ```env
69
- # API Configuration
70
- REACT_APP_API_URL=http://localhost:8000
71
- REACT_APP_CACHE_DURATION=300000 # 5 minutes
72
- ```
73
-
74
- ## πŸ”„ Data Flow
75
-
76
- 1. API fetches leaderboard data from backend
77
- 2. Context stores and manages global state
78
- 3. Hooks handle data processing and filtering
79
- 4. Components render based on processed data
80
- 5. Cache maintains user preferences and URL state