Skip to content

Screenly/qr-code-app

Repository files navigation

Screenly QR Code Generator App

Getting Started

bun install

Deployment

Create and deploy the Edge App:

screenly edge-app create --name my-qr-code --in-place
bun run deploy
screenly edge-app instance create

Configuration

The app accepts the following settings via screenly.yml:

Setting Description Type Default
call_to_action Instruction text below headline optional Scan to visit
display_errors Display detailed error messages on screen optional, advanced false
enable_utm Add UTM tracking parameters (true/false) optional, advanced true
headline Main message displayed above QR code required Visit our website for exclusive offers
url The URL to encode in the QR code required https://www.screenly.io/

UTM Parameters

When enable_utm is enabled, the following parameters are automatically added:

  • utm_source=screenly
  • utm_medium=digital-signage
  • utm_location - Screen location from metadata
  • utm_placement - Screen hostname from metadata

Development

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

Testing

bun test

Screenshots

Generate screenshots at all supported resolutions:

bun run screenshots

Screenshots are saved to the screenshots/ directory.

About

A QR code generator Edge App for Screenly digital signage screens

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors