How rommapp/romm works
Main Components Structure
a) Frontend Layer:
• Vue.js-based SPA (located in /frontend)
• Components for ROM management, game details, player interface
• Vuetify for UI components
• WebSocket client for real-time updates
b) Backend Layer:
• FastAPI application (located in /backend)
• Authentication system
• Database handlers
• File system handlers
• Task scheduling system
c) Storage Layer:
• PostgreSQL database (for ROM metadata, user data)
• Redis (for task queue and caching)
• File system storage (for ROMs, saves, screenshots)
Integration Points
Connections between:
• Frontend and Backend via REST API
• Backend and External Services (IGDB, MobyGames)
• Backend and Storage Systems
• WebSocket connections for real-time updates
Key Architectural Patterns
Patterns:
• Model-View-Controller (MVC) in the backend
• Component-based architecture in the frontend
• Repository pattern for data access
• Task queue pattern for async operations
Detailed Component Breakdown
Backend Services:
• Auth Service
• User Management
• Permission Control
• ROM Management
• Scanning Service
• Metadata Service
• File Management
• Platform Management
• Asset Management
• Screenshots
• Saves
• States
Frontend Modules:
• Core UI Components
• Game Gallery
• Game Details
• Player Interface
• Settings Management
Data Flow Representation
• User requests flow
• Authentication flow
• ROM scanning and metadata enrichment flow
• Game launching flow
• Asset management flow