Skip to main content
Version: 1.2.9

Onboarding Technical Reference

This page describes the onboarding flow sequence presented during the first execution of the application, including persistence state flags and quick skip triggers.

Codebase Map

LayerPathPurpose
Flow Coordinatorqml/TSApp.qmlDetects onboarding status and renders overlay
Onboarding UIqml/features/settings/Onboarding.qmlCarousel slider, guides, and initial config form
State Storagemodels/database.jsDatabase initialization setting verification

Onboarding Execution Flow

Settings Schema Flag

The onboarding state persists in app_settings:

SELECT value FROM app_settings WHERE key = 'first_launch_done';
  • If value is not 1, the application locks general navigation and redirects the active viewport to the onboarding carousel.
  • Completing the onboarding screens automatically updates this key to 1 so subsequent launches bypass the sequence.
  • Users can manually reset this setting via the System Settings page to re-trigger onboarding.