File size: 27,752 Bytes
cf09ddc 6754f1c cf09ddc 6754f1c cf09ddc 6754f1c cf09ddc 6754f1c cf09ddc 6754f1c cf09ddc 6754f1c cf09ddc 6754f1c cf09ddc 6754f1c cf09ddc 6754f1c cf09ddc 6754f1c cf09ddc 6754f1c cf09ddc 6754f1c cf09ddc 6754f1c cf09ddc 6754f1c cf09ddc 6754f1c cf09ddc 6754f1c cf09ddc 6754f1c cf09ddc 6754f1c cf09ddc 6754f1c cf09ddc 6754f1c cf09ddc 6754f1c cf09ddc | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 | # Wall Construction API - GUI Technical Specification
## Philosophy: Minimal Dependencies, Maximum Standards
This specification defines a **production-ready React GUI** with an absolute minimal dependency footprint while adhering to 2025 industry best practices.
**Core Principle**: Every dependency must justify its existence. No bloat, no convenience libraries that add marginal value.
---
## Technology Stack
### Framework & Build Tools
- **React 19.2.0** (October 2025 release)
- Latest stable with React Compiler
- Actions API for async operations
- Enhanced form handling
- Improved hydration and error reporting
- **Vite 7.0** (2025 release)
- Requires Node.js 20.19+ or 22.12+
- ESM-only distribution
- Native `require(esm)` support
- 5x faster builds than Vite 6
- Instant HMR (Hot Module Replacement)
### Styling & UI
- **Tailwind CSS v4.0** (January 2025)
- Zero configuration setup
- Single CSS import: `@import "tailwindcss"`
- Built-in Vite plugin
- 5x faster full builds, 100x faster incremental builds
- Modern CSS features (cascade layers, @property, color-mix)
- P3 color palette for vibrant displays
- Container queries support
### Data Visualization
- **Recharts 2.x** (latest)
- 24.8k GitHub stars
- React-native component API
- SVG-based rendering
- Responsive by default
- Composable chart primitives
- Built on D3.js submodules
### HTTP & State
- **Native Fetch API** (no axios, no external HTTP libs)
- **React useState/useReducer** (no Redux, no Zustand, no external state libs)
---
## Dependencies
### Production Dependencies (3 total)
```json
{
"react": "^19.2.0",
"react-dom": "^19.2.0",
"recharts": "^2.15.0"
}
```
### Development Dependencies (2 total)
```json
{
"vite": "^7.0.0",
"@tailwindcss/vite": "^4.0.0"
}
```
**Total: 5 dependencies**
---
## Project Structure
```
wall-construction-gui/
βββ public/
β βββ favicon.ico
βββ src/
β βββ components/ # Reusable UI components
β β βββ Button.jsx
β β βββ Card.jsx
β β βββ Input.jsx
β β βββ Select.jsx
β β βββ DatePicker.jsx
β β βββ Spinner.jsx
β β βββ ErrorBoundary.jsx
β β βββ charts/
β β βββ LineChart.jsx
β β βββ BarChart.jsx
β β βββ AreaChart.jsx
β βββ pages/ # Page-level components
β β βββ Dashboard.jsx
β β βββ ProfileDetail.jsx
β β βββ SimulationForm.jsx
β β βββ SimulationResults.jsx
β β βββ DailyIceUsage.jsx
β β βββ CostAnalytics.jsx
β βββ hooks/ # Custom React hooks
β β βββ useApi.js
β β βββ useFetch.js
β β βββ useDebounce.js
β βββ utils/ # Helper functions
β β βββ api.js # Fetch wrapper
β β βββ formatters.js # Number/date formatting
β β βββ constants.js # App constants
β βββ App.jsx # Root component
β βββ main.jsx # Entry point
β βββ index.css # Global styles
βββ index.html
βββ vite.config.js
βββ package.json
```
---
## Setup Instructions
### 1. Initialize Project
```bash
# Create Vite project
npm create vite@latest wall-construction-gui -- --template react
cd wall-construction-gui
```
### 2. Install Dependencies
```bash
# Install production dependencies
npm install react@19.2.0 react-dom@19.2.0 recharts
# Install dev dependencies
npm install -D vite@7 @tailwindcss/vite@4
```
### 3. Configure Vite
**vite.config.js**
```javascript
import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'
import tailwindcss from '@tailwindcss/vite'
export default defineConfig({
plugins: [
react(),
tailwindcss()
],
server: {
port: 5173,
proxy: {
'/api': {
target: 'http://localhost:8000',
changeOrigin: true
}
}
}
})
```
### 4. Setup Tailwind CSS
**src/index.css**
```css
@import "tailwindcss";
/* CSS Custom Properties for Theme */
:root {
--color-primary: #3b82f6;
--color-secondary: #64748b;
--color-success: #10b981;
--color-danger: #ef4444;
--color-warning: #f59e0b;
--color-ice: #93c5fd;
--color-gold: #fbbf24;
}
/* Global Styles */
body {
@apply bg-gray-50 text-gray-900;
}
```
### 5. Run Development Server
```bash
npm run dev
```
Server starts at `http://localhost:5173`
---
## Component Architecture
### Base Components
#### Button Component
```jsx
// src/components/Button.jsx
export default function Button({
children,
variant = 'primary',
onClick,
disabled = false,
type = 'button'
}) {
const variants = {
primary: 'bg-blue-600 hover:bg-blue-700 text-white',
secondary: 'bg-gray-200 hover:bg-gray-300 text-gray-900',
danger: 'bg-red-600 hover:bg-red-700 text-white'
}
return (
<button
type={type}
onClick={onClick}
disabled={disabled}
className={`
px-4 py-2 rounded-lg font-medium
transition-colors duration-200
disabled:opacity-50 disabled:cursor-not-allowed
${variants[variant]}
`}
>
{children}
</button>
)
}
```
#### Card Component
```jsx
// src/components/Card.jsx
export default function Card({ children, className = '' }) {
return (
<div className={`bg-white rounded-lg shadow-md p-6 ${className}`}>
{children}
</div>
)
}
```
#### Input Component
```jsx
// src/components/Input.jsx
export default function Input({
label,
type = 'text',
value,
onChange,
placeholder,
required = false,
error
}) {
return (
<div className="mb-4">
{label && (
<label className="block text-sm font-medium text-gray-700 mb-2">
{label}
{required && <span className="text-red-500 ml-1">*</span>}
</label>
)}
<input
type={type}
value={value}
onChange={(e) => onChange(e.target.value)}
placeholder={placeholder}
required={required}
className={`
w-full px-4 py-2 border rounded-lg
focus:outline-none focus:ring-2 focus:ring-blue-500
${error ? 'border-red-500' : 'border-gray-300'}
`}
/>
{error && (
<p className="text-red-500 text-sm mt-1">{error}</p>
)}
</div>
)
}
```
### Chart Components
#### LineChart Wrapper
```jsx
// src/components/charts/LineChart.jsx
import {
LineChart as RechartsLine,
Line,
XAxis,
YAxis,
CartesianGrid,
Tooltip,
ResponsiveContainer
} from 'recharts'
export default function LineChart({ data, dataKey, xKey, color = '#3b82f6' }) {
return (
<ResponsiveContainer width="100%" height={300}>
<RechartsLine data={data}>
<CartesianGrid strokeDasharray="3 3" />
<XAxis dataKey={xKey} />
<YAxis />
<Tooltip />
<Line
type="monotone"
dataKey={dataKey}
stroke={color}
strokeWidth={2}
/>
</RechartsLine>
</ResponsiveContainer>
)
}
```
#### BarChart Wrapper
```jsx
// src/components/charts/BarChart.jsx
import {
BarChart as RechartsBar,
Bar,
XAxis,
YAxis,
CartesianGrid,
Tooltip,
ResponsiveContainer
} from 'recharts'
export default function BarChart({ data, dataKey, xKey, color = '#10b981' }) {
return (
<ResponsiveContainer width="100%" height={300}>
<RechartsBar data={data}>
<CartesianGrid strokeDasharray="3 3" />
<XAxis dataKey={xKey} />
<YAxis />
<Tooltip />
<Bar dataKey={dataKey} fill={color} />
</RechartsBar>
</ResponsiveContainer>
)
}
```
---
## Pages
### 1. Dashboard
**File**: `src/pages/Dashboard.jsx`
**Purpose**: Display simulation results overview with total statistics
**Data Source**: `GET /api/simulation/overview/total/`
**Components**:
- Grid of profile cards
- Summary statistics (total ice, total cost, total feet)
- "View Details" button per profile
- "+ New Profile" button
**Key Features**:
- Responsive grid (1 col mobile, 2 col tablet, 3 col desktop)
- Loading states with skeleton cards
- Empty state when no profiles exist
- Filter by active/inactive status
### 2. ProfileDetail
**File**: `src/pages/ProfileDetail.jsx`
**Purpose**: Detailed view of simulation results by day
**Data Source**: `GET /api/simulation/overview/{day}/` or `GET /api/simulation/overview/all-by-day/`
**Components**:
- Profile header (name, team lead)
- Summary cards (total cost, total ice, avg/day)
- Line chart: Daily cost trend
- Line chart: Daily feet built
- Area chart: Cumulative cost
- Data table: Daily breakdown
**Key Features**:
- Date range picker (default: last 30 days)
- Responsive charts
- Download CSV button (client-side generation)
- Print-friendly layout
### 3. SimulationForm
**File**: `src/pages/SimulationForm.jsx`
**Purpose**: Run wall construction simulation with multi-profile configuration
**Data Source**: `POST /api/simulation/simulate/`
**Components**:
- Configuration textarea (multi-line input for wall heights)
- Number of teams input (default: 10)
- Run Simulation button
- Example config link/tooltip
- Results display area (summary statistics)
- View Logs button (navigates to SimulationResults)
**Key Features**:
- Config format validation (numbers only, range 0-30)
- Example: "5, 10, 15" creates 3 profiles with heights 5, 10, 15
- Real-time simulation execution
- Summary display: total ice used, total cost, days to completion
- Success/error notifications
- Link to detailed logs and daily breakdown
### 4. SimulationResults
**File**: `src/pages/SimulationResults.jsx`
**Purpose**: Display detailed simulation logs and daily progress
**Data Source**: Read from `/logs/team_*.log` files or use `GET /api/simulation/overview/all-by-day/`
**Components**:
- Log viewer (scrollable text area with team logs)
- Day-by-day summary table
- Team status indicators (working/relieved)
- Simulation summary statistics
**Key Features**:
- Syntax-highlighted log display
- Filter logs by team number
- Download logs button
- Refresh simulation button
### 5. DailyIceUsage
**File**: `src/pages/DailyIceUsage.jsx`
**Purpose**: Breakdown of ice usage by wall section for a specific date
**Data Source**: `GET /api/profiles/{id}/daily-ice-usage/?date=YYYY-MM-DD`
**Components**:
- Profile selector
- Date picker
- Summary card (total feet, total ice)
- Horizontal bar chart (ice by section)
- Data table (section breakdown with percentages)
**Key Features**:
- Client-side percentage calculations
- Color-coded bars
- Sortable table columns
- Export to CSV
### 6. CostAnalytics
**File**: `src/pages/CostAnalytics.jsx`
**Purpose**: Multi-chart cost analytics dashboard
**Data Source**: `GET /api/simulation/overview/all-by-day/`
**Components**:
- Date range selector
- 4 summary cards (total cost, total feet, avg/day, days)
- Line chart: Daily cost
- Line chart: Daily feet built
- Area chart: Cumulative cost
- Compare profiles (optional enhancement)
**Key Features**:
- Multiple chart views in grid layout
- Responsive breakpoints
- Print view
- Share URL with date filters in query params
---
## API Integration
### API Client
**src/utils/api.js**
```javascript
const API_BASE = import.meta.env.DEV ? '/api' : 'https://api.example.com/api'
class ApiError extends Error {
constructor(message, status, data) {
super(message)
this.status = status
this.data = data
}
}
async function request(endpoint, options = {}) {
const url = `${API_BASE}${endpoint}`
const config = {
headers: {
'Content-Type': 'application/json',
...options.headers
},
...options
}
try {
const response = await fetch(url, config)
const data = await response.json()
if (!response.ok) {
throw new ApiError(
data.message || 'Request failed',
response.status,
data
)
}
return data
} catch (error) {
if (error instanceof ApiError) {
throw error
}
throw new ApiError('Network error', 0, { originalError: error })
}
}
export const api = {
// Profiles (CRUD endpoints for manual management)
getProfiles: () => request('/profiles/'),
getProfile: (id) => request(`/profiles/${id}/`),
createProfile: (data) => request('/profiles/', {
method: 'POST',
body: JSON.stringify(data)
}),
// Simulation
runSimulation: (config, numTeams = 10) => request('/simulation/simulate/', {
method: 'POST',
body: JSON.stringify({ config, num_teams: numTeams })
}),
// Analytics
getOverviewTotal: () => request('/simulation/overview/total/'),
getOverviewByDay: (day) => request(`/simulation/overview/${day}/`),
getOverviewAllByDay: () => request('/simulation/overview/all-by-day/')
}
```
### Custom Hooks
**src/hooks/useFetch.js**
```javascript
import { useState, useEffect } from 'react'
export function useFetch(fetchFn, dependencies = []) {
const [data, setData] = useState(null)
const [loading, setLoading] = useState(true)
const [error, setError] = useState(null)
useEffect(() => {
let cancelled = false
async function fetchData() {
try {
setLoading(true)
setError(null)
const result = await fetchFn()
if (!cancelled) {
setData(result)
}
} catch (err) {
if (!cancelled) {
setError(err)
}
} finally {
if (!cancelled) {
setLoading(false)
}
}
}
fetchData()
return () => {
cancelled = true
}
}, dependencies)
return { data, loading, error }
}
```
**Usage Example**:
```javascript
import { useFetch } from '../hooks/useFetch'
import { api } from '../utils/api'
function Dashboard() {
const { data: profiles, loading, error } = useFetch(() => api.getProfiles())
if (loading) return <Spinner />
if (error) return <ErrorMessage error={error} />
return (
<div className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 gap-6">
{profiles.results.map(profile => (
<ProfileCard key={profile.id} profile={profile} />
))}
</div>
)
}
```
---
## State Management Strategy
### Component-Level State
Use `useState` for:
- Form inputs
- UI toggles (modals, dropdowns)
- Local loading/error states
### Lifted State
Use props drilling for:
- Shared data between sibling components
- Parent-child communication
**Example**:
```javascript
function App() {
const [currentView, setCurrentView] = useState('dashboard')
const [selectedProfile, setSelectedProfile] = useState(null)
return (
<div>
<Navigation view={currentView} onNavigate={setCurrentView} />
{currentView === 'dashboard' && (
<Dashboard onSelectProfile={setSelectedProfile} />
)}
{currentView === 'profile' && (
<ProfileDetail profile={selectedProfile} />
)}
</div>
)
}
```
### When to Add Context
Only add React Context if:
- Props drilling exceeds 3 levels
- Data is truly global (theme, auth, language)
- Performance profiling shows re-render issues
**Not needed for this app initially**.
---
## Routing Strategy
### Hash-Based Routing (Minimal Approach)
**src/App.jsx**
```javascript
import { useState, useEffect } from 'react'
import Dashboard from './pages/Dashboard'
import ProfileDetail from './pages/ProfileDetail'
import SimulationForm from './pages/SimulationForm'
import SimulationResults from './pages/SimulationResults'
function App() {
const [route, setRoute] = useState(window.location.hash.slice(1) || 'dashboard')
const [params, setParams] = useState({})
useEffect(() => {
const handleHashChange = () => {
const hash = window.location.hash.slice(1)
const [path, query] = hash.split('?')
setRoute(path || 'dashboard')
// Parse query params
const searchParams = new URLSearchParams(query)
const paramsObj = {}
searchParams.forEach((value, key) => {
paramsObj[key] = value
})
setParams(paramsObj)
}
window.addEventListener('hashchange', handleHashChange)
return () => window.removeEventListener('hashchange', handleHashChange)
}, [])
const navigate = (path, queryParams = {}) => {
const query = new URLSearchParams(queryParams).toString()
window.location.hash = query ? `${path}?${query}` : path
}
return (
<div className="min-h-screen bg-gray-50">
<nav className="bg-white shadow-sm mb-6">
<div className="max-w-7xl mx-auto px-4 py-4">
<div className="flex gap-4">
<button onClick={() => navigate('dashboard')}
className={route === 'dashboard' ? 'font-bold' : ''}>
Dashboard
</button>
<button onClick={() => navigate('simulation')}
className={route === 'simulation' ? 'font-bold' : ''}>
Run Simulation
</button>
<button onClick={() => navigate('results')}
className={route === 'results' ? 'font-bold' : ''}>
View Results
</button>
</div>
</div>
</nav>
<main className="max-w-7xl mx-auto px-4">
{route === 'dashboard' && <Dashboard navigate={navigate} />}
{route === 'profile' && <ProfileDetail profileId={params.id} navigate={navigate} />}
{route === 'simulation' && <SimulationForm navigate={navigate} />}
{route === 'results' && <SimulationResults navigate={navigate} />}
</main>
</div>
)
}
export default App
```
### URL Structure
```
/#dashboard
/#profile?id=1
/#simulation
/#results
/#ice-usage?id=1&date=2025-10-15
```
---
## Styling Guidelines
### Tailwind Utility Classes
- Use composition for common patterns
- Avoid inline style objects
- Keep classes readable (multi-line for complex components)
**Good**:
```jsx
<div className="
flex items-center justify-between
bg-white rounded-lg shadow-md
p-6 mb-4
hover:shadow-lg transition-shadow
">
```
**Bad**:
```jsx
<div style={{ display: 'flex', padding: '24px', background: 'white' }}>
```
### Responsive Design
Use Tailwind breakpoints:
- `sm:` - 640px
- `md:` - 768px
- `lg:` - 1024px
- `xl:` - 1280px
**Example**:
```jsx
<div className="
grid
grid-cols-1
md:grid-cols-2
lg:grid-cols-3
gap-6
">
```
### Color Palette
Use Tailwind's default colors + custom properties:
```css
:root {
--color-ice: #93c5fd; /* Light blue for ice theme */
--color-gold: #fbbf24; /* Gold for currency */
}
```
Apply in Tailwind:
```jsx
<div className="bg-[var(--color-ice)]">
```
---
## Error Handling
### Error Boundary Component
**src/components/ErrorBoundary.jsx**
```javascript
import { Component } from 'react'
class ErrorBoundary extends Component {
constructor(props) {
super(props)
this.state = { hasError: false, error: null }
}
static getDerivedStateFromError(error) {
return { hasError: true, error }
}
componentDidCatch(error, errorInfo) {
console.error('Error caught by boundary:', error, errorInfo)
}
render() {
if (this.state.hasError) {
return (
<div className="min-h-screen flex items-center justify-center bg-gray-50">
<div className="bg-white p-8 rounded-lg shadow-lg max-w-md">
<h2 className="text-2xl font-bold text-red-600 mb-4">
Something went wrong
</h2>
<p className="text-gray-600 mb-4">
{this.state.error?.message || 'An unexpected error occurred'}
</p>
<button
onClick={() => window.location.reload()}
className="bg-blue-600 text-white px-4 py-2 rounded-lg hover:bg-blue-700"
>
Reload Page
</button>
</div>
</div>
)
}
return this.props.children
}
}
export default ErrorBoundary
```
### API Error Handling
Display user-friendly error messages:
```javascript
function ErrorMessage({ error }) {
const getMessage = () => {
if (error.status === 404) return 'Resource not found'
if (error.status === 500) return 'Server error. Please try again later.'
if (error.status === 0) return 'Network error. Check your connection.'
return error.message || 'An error occurred'
}
return (
<div className="bg-red-50 border border-red-200 rounded-lg p-4">
<p className="text-red-800">{getMessage()}</p>
</div>
)
}
```
---
## Performance Optimization
### Code Splitting (Future Enhancement)
When bundle size grows, use React.lazy:
```javascript
import { lazy, Suspense } from 'react'
const ProfileDetail = lazy(() => import('./pages/ProfileDetail'))
function App() {
return (
<Suspense fallback={<Spinner />}>
<ProfileDetail />
</Suspense>
)
}
```
### Memoization
Use React.memo for expensive list items:
```javascript
import { memo } from 'react'
const ProfileCard = memo(function ProfileCard({ profile }) {
return (
<Card>
<h3>{profile.name}</h3>
<p>{profile.team_lead}</p>
</Card>
)
})
```
### Debouncing
For search/filter inputs:
```javascript
// src/hooks/useDebounce.js
import { useState, useEffect } from 'react'
export function useDebounce(value, delay = 300) {
const [debouncedValue, setDebouncedValue] = useState(value)
useEffect(() => {
const timer = setTimeout(() => {
setDebouncedValue(value)
}, delay)
return () => clearTimeout(timer)
}, [value, delay])
return debouncedValue
}
```
---
## Build & Deployment
### Development Build
```bash
npm run dev
```
### Production Build
```bash
npm run build
```
Output: `dist/` directory with optimized static files
### Preview Production Build
```bash
npm run preview
```
### Build Optimizations (Vite 7)
- Automatic code splitting
- CSS minification
- Tree shaking
- Asset optimization (images, fonts)
- Source maps (optional)
**vite.config.js** (production settings):
```javascript
export default defineConfig({
plugins: [react(), tailwindcss()],
build: {
sourcemap: false,
minify: 'esbuild',
target: 'es2020',
rollupOptions: {
output: {
manualChunks: {
'react-vendor': ['react', 'react-dom'],
'charts': ['recharts']
}
}
}
}
})
```
---
## HuggingFace Space Deployment
### Static Site Setup
**Dockerfile**
```dockerfile
FROM nginx:alpine
# Copy built files
COPY dist /usr/share/nginx/html
# Copy nginx config
COPY nginx.conf /etc/nginx/nginx.conf
EXPOSE 7860
CMD ["nginx", "-g", "daemon off;"]
```
**nginx.conf**
```nginx
events {
worker_connections 1024;
}
http {
include /etc/nginx/mime.types;
default_type application/octet-stream;
server {
listen 7860;
server_name _;
root /usr/share/nginx/html;
index index.html;
# SPA fallback
location / {
try_files $uri $uri/ /index.html;
}
# API proxy (if Django backend in same Space)
location /api {
proxy_pass http://localhost:8000;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
}
}
}
```
### Space Configuration
**README.md** (HuggingFace header):
```yaml
---
title: Wall Construction Tracker
emoji: π°
colorFrom: blue
colorTo: gray
sdk: docker
app_port: 7860
---
```
### Environment Variables
**src/utils/api.js**:
```javascript
const API_BASE = import.meta.env.VITE_API_BASE || '/api'
```
**.env.production**:
```
VITE_API_BASE=https://your-api-domain.com/api
```
---
## Testing Strategy (Future Enhancement)
When tests become necessary:
### Unit Tests
- Vitest (Vite-native test runner)
- React Testing Library
- Test utilities, formatters, API client
### Integration Tests
- Test page-level components
- Mock API responses
- Test user workflows
### E2E Tests
- Playwright or Cypress
- Test critical paths (record progress, view analytics)
**Not included in minimal spec** - add when project matures.
---
## Accessibility (a11y)
### Semantic HTML
Use proper elements:
```jsx
<button> instead of <div onClick>
<nav> for navigation
<main> for main content
<header>, <footer> for sections
```
### ARIA Labels
```jsx
<button aria-label="Close modal">Γ</button>
<input aria-describedby="error-message" />
```
### Keyboard Navigation
- All interactive elements focusable
- Visible focus states
- Logical tab order
### Color Contrast
- WCAG AA minimum (4.5:1 for text)
- Use Tailwind's accessible color combinations
---
## Development Workflow
### 1. Start Backend (Django)
```bash
cd /path/to/django/backend
python manage.py runserver
```
### 2. Start Frontend (Vite)
```bash
cd /path/to/react/frontend
npm run dev
```
### 3. Access Application
- Frontend: http://localhost:5173
- Backend API: http://localhost:8000/api
- Vite proxies `/api` requests to backend
### 4. Make Changes
- Edit React components
- Save file
- Vite HMR updates browser instantly (no refresh needed)
---
## Code Quality Standards
### Formatting
- Consistent indentation (2 spaces)
- Trailing commas in multiline arrays/objects
- Single quotes for strings
- Semicolons optional (be consistent)
### Naming Conventions
- Components: PascalCase (`ProfileCard.jsx`)
- Hooks: camelCase with `use` prefix (`useFetch.js`)
- Utilities: camelCase (`formatNumber.js`)
- Constants: UPPER_SNAKE_CASE (`API_BASE`)
### File Organization
- One component per file
- Group related components in folders
- Keep files under 200 lines
- Extract complex logic to hooks/utils
### Comments
- Use JSDoc for functions
- Explain "why", not "what"
- Remove commented-out code
**Example**:
```javascript
/**
* Formats a number as currency (Gold Dragons)
* @param {number} value - The value to format
* @returns {string} Formatted string like "1,234,567 GD"
*/
function formatCurrency(value) {
return `${value.toLocaleString()} GD`
}
```
---
## Browser Support
### Target Browsers (Vite 7 defaults)
- Chrome 107+
- Edge 107+
- Firefox 104+
- Safari 16.0+
These align with Vite 7's "baseline-widely-available" target.
### Polyfills
None needed - modern browsers support:
- ES2020 syntax
- Fetch API
- Async/await
- CSS Grid/Flexbox
- CSS custom properties
---
## Future Enhancements (Not in Minimal Spec)
### When to Add
1. **React Router** - When hash-based routing becomes limiting
2. **React Context** - When props drilling exceeds 3 levels
3. **React Query** - When caching/invalidation becomes complex
4. **TypeScript** - When team grows or errors increase
5. **Testing** - When regression bugs appear frequently
6. **Storybook** - When design system emerges
7. **i18n** - When internationalization is required
8. **PWA** - When offline support is needed
### Don't Add Unless Needed
- Redux (useState is sufficient)
- CSS-in-JS (Tailwind is enough)
- Component libraries (build your own)
- Lodash (native JS is powerful enough)
---
## Summary
This specification defines a **minimal, production-ready React GUI** with:
β
**5 total dependencies** (React, ReactDOM, Recharts, Vite, Tailwind)
β
**Modern 2025 stack** (React 19.2, Vite 7, Tailwind v4)
β
**Zero configuration** (Tailwind v4, Vite auto-discovery)
β
**Fast builds** (5x faster with Vite 7 + Tailwind v4)
β
**Component-based architecture** (reusable, composable)
β
**Hash-based routing** (no external router)
β
**Native fetch** (no HTTP libraries)
β
**Simple state management** (useState/props)
β
**Recharts integration** (SVG-based, responsive charts)
β
**Tailwind styling** (utility-first, no CSS frameworks)
β
**HuggingFace Space ready** (Docker, nginx, static build)
**Philosophy**: Start minimal, add dependencies only when complexity demands it.
|