How shahidshabbir-se/race-engineer works
Project Type and Purpose
• This is a desktop, full-stack application (“Race Engineer Application”) built with Tauri (Rust) as the backend and SvelteKit (TypeScript + Skeleton UI) as the frontend.
• Purpose: Read Richard Burns Rally (RBR) JSON files directly from the user’s RBR installation directory and display game state data (cars, tracks) in a user-friendly GUI. No database—pure file I/O.
File Structure
• Top-level directories:
• app/ – Contains the Tauri + SvelteKit application
• data/ – Sample RBR JSON files & extraction scripts for development/testing
• docs/ – Requirements, data models, AI-coding guidelines
• In app/:
• src-tauri/ – Rust backend (“core”)
– core/*.rs – Modules handling domain logic (cars, stages, settings)
– main.rs – Tauri setup, IPC handlers
– tauri.conf.json, build.rs
• src/ – SvelteKit frontend
– routes/ – Page layouts, navigation (dashboard, platform, settings)
– components/ – UI pieces (carData, carGroups, spinner, etc.)
• config files: package.json, pnpm-lock.yaml, vite.config.js, tsconfig.json, svelte.config.js
• Testing: Emphasis on unit tests for both Rust and Svelte components (per README).
Key Architecture Insights from README
• All business logic + file access in Rust backend via Tauri.
• Frontend is “thin”—handles only presentation & user events.
• Persistent configuration limited to one setting: RBR install path (stored in Tauri settings).
a. Main Components
• Frontend (SvelteKit + Skeleton UI)
• Backend (Tauri + Rust core modules)
• Local File System (RBR JSON files, user’s config)
• Development Data Source (data/ samples)
b. Relationships & Interactions
1. User interacts with Frontend UI
2. Frontend sends IPC requests (via Tauri’s JavaScript-Rust bridge)
3. Tauri backend receives requests → invokes Rust core modules
4. Rust modules read RBR JSON files from the file system
5. Parse data into in-memory domain models → return results over IPC
6. Frontend renders data in components
c. Architectural Patterns & Principles
• Clear separation of concerns: UI vs. business logic
• IPC-based interface boundary (Tauri)
• Domain-driven design in Rust modules (car.rs, stages_data.rs, settings.rs)
• No database layer; direct file access
• Sample data directory for test harnesses—separate from production FS
d. Key Technologies & Frameworks
• SvelteKit (routes, components) + Skeleton UI
• Tauri (Rust + webview), ts-rs for TypeScript bindings
• Vite (dev server, build)
• Node.js / pnpm for frontend dependencies
• Shell script (extract_json_samples.sh) for populating sample data