How john-henriquez/speedcube-timer works
Speedcube Timer is an offline-first speedcubing web app with a Django sync API. The main workflow is recording solves locally, reviewing statistics and training progress, and optionally syncing records across devices. Separate branches provide the OLL/PLL almanac and structured training zones. The graph includes the local persistence and synchronization layers; links for unsampled pages or backend routing are limited to documented or indexed references.
Main entry points: App.jsx App shell · index.js Storage facade · AlmanacPage.jsx Case almanac · syncClient.js Sync client
Components 25
Web app
- App shell
frontend/src/App.jsx - Solve timer
frontend/src/pages/TimerPage.jsx - Calendar and stats
frontend/src/pages/CalendarPage.jsx
Training and almanac
- Zone practice
frontend/src/pages/TrainingPage.jsx - Case almanac
frontend/src/pages/AlmanacPage.jsx - OLL PLL catalog
frontend/src/catalog/data.js - Catalog analysis
frontend/src/catalog/analysis.js - Case selection
frontend/src/training/selection.js - Training zones
frontend/src/training/zones/index.js - Attempt records
frontend/src/training/attempts.js - Cube simulator
frontend/src/core/cube/cube.js
Local data and sync
- Solve state
frontend/src/hooks/useSolves.js - Attempt state
frontend/src/hooks/useAttempts.js - Almanac preferences
frontend/src/hooks/useAlmanac.js - Storage facade
frontend/src/storage/index.js - IndexedDB
frontend/src/storage/indexedDb.js - Sync scheduling
frontend/src/hooks/useSync.js - Sync client
frontend/src/sync/syncClient.js - Record mapping
frontend/src/sync/mapping.js
Sync API
- Sync endpoints
backend/timer/views.py - API serializers
backend/timer/serializers.py - User records
backend/timer/models.py
Other components
- Speedcuber
- Browser fetch
- Django API
Connections 31
- Speedcuber → App shell: uses
- App shell → Solve timer: renders
frontend/src/App.jsx - App shell → Calendar and stats: renders
frontend/src/App.jsx - App shell → Zone practice: renders
frontend/src/App.jsx - App shell → Case almanac: renders
frontend/src/App.jsx - App shell → Solve state: loads
frontend/src/App.jsx - App shell → Attempt state: loads
frontend/src/App.jsx - App shell → Almanac preferences: loads
frontend/src/App.jsx - App shell → Sync scheduling: starts
frontend/src/App.jsx - Case almanac → OLL PLL catalog: reads cases
frontend/src/pages/AlmanacPage.jsx - Case almanac → Case selection: filters cases
frontend/src/pages/AlmanacPage.jsx - Case almanac → Training zones: loads zone cases
frontend/src/pages/AlmanacPage.jsx - OLL PLL catalog → Catalog analysis: analyzes algorithms
frontend/src/catalog/index.js - Catalog analysis → Cube simulator: simulates moves
frontend/src/catalog/analysis.js - Zone practice → Training zones: uses zones
- Zone practice → Attempt state: records practice
frontend/src/App.jsx - Attempt state → Attempt records: validates records
frontend/src/hooks/useAttempts.js - Calendar and stats → Solve state: reads solves
frontend/src/pages/CalendarPage.jsx - Solve state → Storage facade: loads and saves
frontend/src/hooks/useSolves.js - Attempt state → Storage facade: loads and saves
frontend/src/hooks/useAttempts.js - Almanac preferences → Storage facade: stores preferences
frontend/src/hooks/useAlmanac.js - Storage facade → IndexedDB: delegates storage
frontend/src/storage/index.js - Sync scheduling → Sync client: runs sync
frontend/src/hooks/useSync.js - Sync client → Storage facade: reads and applies
frontend/src/sync/syncClient.js - Sync client → Record mapping: maps records
frontend/src/sync/syncClient.js - Sync client → Browser fetch: sends requests
frontend/src/sync/syncClient.js - Browser fetch → Django API: calls API
README.md - Django API → Sync endpoints: routes requests
README.md - Sync endpoints → API serializers: validates data
backend/timer/views.py - Sync endpoints → User records: reads and writes
backend/timer/views.py - API serializers → User records: serializes records
backend/timer/serializers.py