bun installCreate and deploy the Edge App:
screenly edge-app create --name my-menu-board --in-place
bun run deploy
screenly edge-app instance createThe app accepts the following settings via screenly.yml:
| Setting | Description | Type | Default |
|---|---|---|---|
accent_color |
Color for highlights and borders | optional | rgba(255, 255, 255, 0.95) |
background_image |
URL to a background image | optional | - |
currency |
Currency symbol to display with prices | optional | $ |
display_errors |
Display detailed error messages on screen | optional, advanced | false |
logo_url |
URL to your restaurant's logo | optional | - |
menu_title |
The title displayed at the top of the menu | required | Today's Menu |
item_XX_description |
Description of menu item XX (where XX is 01-25, zero-padded; e.g., item_01_description) |
optional | - |
item_XX_labels |
Comma-separated labels for menu item XX (e.g., vegetarian, spicy, gluten-free; where XX is 01-25) |
optional | - |
item_XX_name |
Name of menu item XX (where XX is 01-25, zero-padded). Items without a name will be skipped |
optional | - |
item_XX_price |
Price of menu item XX (where XX is 01-25, zero-padded; e.g., item_01_price) |
optional | - |
The app comes with four sample pizza items pre-configured for demonstration purposes:
- Classic Margherita ($13.99) - San Marzano tomatoes, fresh mozzarella, basil, extra virgin olive oil • vegetarian
- Pepperoni Supreme ($15.99) - Double pepperoni, mozzarella, parmesan, homemade tomato sauce, oregano • spicy
- Four Cheese ($16.99) - Mozzarella, gorgonzola, parmesan, fontina, fresh basil, garlic olive oil • vegetarian
- Mediterranean Veggie ($14.99) - Roasted bell peppers, kalamata olives, red onions, cherry tomatoes, feta, spinach • vegetarian, gluten-free
You can customize or replace these items with your own menu content.
bun install # Install dependencies
bun run dev # Start development serverbun testGenerate screenshots at all supported resolutions:
bun run screenshotsScreenshots are saved to the screenshots/ directory.