How jnpetersen/remote-falcon works
Remote Falcon lets show owners configure a public Viewer Page and lets visitors request or vote for songs; the plugin-facing API supports show playback and queue synchronization. The principal flow is viewer interaction through the web app and API into queue/vote state, with the plugin reading playback decisions. The graph preserves account/control-panel, viewer, plugin, and data responsibilities documented by the tree and README. Several API controllers and service implementations were not sampled, so their internal links are omitted; the web-to-API boundary is documented at a high level.
Main entry points: Application.java HTTP API · ControlPanelService.java Owner settings · PluginService.java Plugin synchronization · App.js Web application
Components 24
Web experience
- Web application
remote-falcon-web/src/App.js - Sign-in UI
remote-falcon-web/src/views/pages/authentication/Login.js - Control panel UI
remote-falcon-web/src/views/pages/controlPanel - Viewer page UI
remote-falcon-web/src/views/pages/externalViewer/index.js - Authentication client
remote-falcon-web/src/services/authentication/authentication.service.js - Control panel clients
remote-falcon-web/src/services/controlPanel - Viewer client
remote-falcon-web/src/services/viewer/viewerPage.service.js
API workflows
- HTTP API
remote-falcon-api/src/main/java/com/remotefalcon/api/Application.java - Account workflows
remote-falcon-api/src/main/java/com/remotefalcon/api/service/AccountService.java - Owner settings
remote-falcon-api/src/main/java/com/remotefalcon/api/service/ControlPanelService.java - Viewer interactions
remote-falcon-api/src/main/java/com/remotefalcon/api/service/ViewerPageService.java - Plugin synchronization
remote-falcon-api/src/main/java/com/remotefalcon/api/service/PluginService.java - JWT access checks
remote-falcon-api/src/main/java/com/remotefalcon/api/util/AuthUtil.java
Show state
- Show account
remote-falcon-api/src/main/java/com/remotefalcon/api/entity/Remote.java - Show preferences
remote-falcon-api/src/main/java/com/remotefalcon/api/entity/RemotePreference.java - Song catalog
remote-falcon-api/src/main/java/com/remotefalcon/api/entity/Playlist.java - Request queue
remote-falcon-api/src/main/java/com/remotefalcon/api/entity/RemoteJuke.java - Playlist persistence
remote-falcon-api/src/main/java/com/remotefalcon/api/repository/PlaylistRepository.java - Account persistence
remote-falcon-api/src/main/java/com/remotefalcon/api/repository/RemoteRepository.java - Queue persistence
remote-falcon-api/src/main/java/com/remotefalcon/api/repository/RemoteJukeRepository.java - SQL database
Other components
- Show owner
- Viewer
- FPP / xSchedule
Connections 31
- Show owner → Web application: uses
README.md - Viewer → Web application: visits
README.md - Web application → Sign-in UI: routes to
- Web application → Control panel UI: routes to
- Web application → Viewer page UI: routes to
- Sign-in UI → Authentication client: authenticates via
remote-falcon-web/src/services/authentication/authentication.service.js - Control panel UI → Control panel clients: loads data via
- Viewer page UI → Viewer client: loads page via
- Authentication client → HTTP API: calls
- Control panel clients → HTTP API: calls
- Viewer client → HTTP API: calls
- HTTP API → Account workflows: dispatches
- HTTP API → Owner settings: dispatches
- HTTP API → Viewer interactions: dispatches
- HTTP API → Plugin synchronization: dispatches
- Owner settings → Show account: reads / updates
remote-falcon-api/src/main/java/com/remotefalcon/api/service/ControlPanelService.java - Owner settings → Show preferences: updates
remote-falcon-api/src/main/java/com/remotefalcon/api/controller/ControlPanelController.java - Owner settings → Song catalog: manages
remote-falcon-api/src/main/java/com/remotefalcon/api/controller/ControlPanelController.java - Viewer interactions → Song catalog: reads
remote-falcon-api/src/main/java/com/remotefalcon/api/service/ViewerPageService.java - Viewer interactions → Request queue: queues requests
remote-falcon-api/src/main/java/com/remotefalcon/api/service/ViewerPageService.java - Plugin synchronization → Song catalog: synchronizes
remote-falcon-api/src/main/java/com/remotefalcon/api/service/PluginService.java - Plugin synchronization → Request queue: updates queue
remote-falcon-api/src/main/java/com/remotefalcon/api/service/PluginService.java - JWT access checks → Show account: validates identity
remote-falcon-api/src/main/java/com/remotefalcon/api/util/AuthUtil.java - Owner settings → Playlist persistence: uses
remote-falcon-api/src/main/java/com/remotefalcon/api/service/ControlPanelService.java - Viewer interactions → Playlist persistence: queries
remote-falcon-api/src/main/java/com/remotefalcon/api/service/ViewerPageService.java - Plugin synchronization → Playlist persistence: queries / saves
remote-falcon-api/src/main/java/com/remotefalcon/api/service/PluginService.java - Plugin synchronization → Queue persistence: queries / saves
remote-falcon-api/src/main/java/com/remotefalcon/api/service/PluginService.java - Playlist persistence → SQL database: persists
- Account persistence → SQL database: persists
- Queue persistence → SQL database: persists
- FPP / xSchedule → HTTP API: synchronizes show
README.md