Welcome App

Getting Started

bun install

Deployment

Create and deploy the Edge App:

screenly edge-app create --name welcome-app --in-place
bun run deploy
screenly edge-app instance create

Configuration

The app accepts the following settings via screenly.yml:

Setting	Description	Type	Default
enable_analytics	Enable or disable Sentry and Google Analytics integrations	optional	true
override_locale	Override the default locale with a supported language code (e.g., en_US, fr_FR, de_DE)	optional	en
override_timezone	Override the default timezone with a supported timezone identifier (e.g., Europe/London, America/New_York). Defaults to the system timezone if left blank	optional	-
tag_manager_id	Google Tag Manager container ID to enable tracking and analytics	optional	GTM-P98SPZ9Z
welcome_heading	Heading text displayed as the welcome message title	required	Welcome
welcome_message	Body text displayed as the welcome message content	required	to the team

Development

bun install      # Install dependencies
bun run dev      # Start development server

Build

bun run build    # Build for production

Lint & Format

bun run lint     # Lint and auto-fix
bun run format   # Format source files

Testing

bun test         # Run unit tests

Screenshots

Generate screenshots at all supported resolutions:

bun run screenshots

Screenshots are saved to the screenshots/ directory.