Skip to content

Backboard-io/StatusApp

Repository files navigation

Backboard Status

A tiny desktop overlay that keeps an eye on the Backboard API—green when it’s happy, yellow when something’s off. Built with Electron + React + Tailwind.


✨ See it in action

Backboard Status — polling, minimode, settings, and expand

Drag it. Shrink it. Change the poll interval. One click to expand again.


🚀 Quick start

./start.sh

This clears local build artifacts and starts the app (Vite dev server + Electron). The overlay appears in the corner and starts polling the API.

First time? Install dependencies:

npm install

What you get

Feature Description
Live status Polls https://app.backboard.io/api on a schedule. Green = “Welcome to Backboard API”, yellow = unexpected response, red = error or timeout.
Poll interval Gear icon → choose 1 s, 2 s, 5 s, or 10 s.
Minimode Small 1×1-style tile for tight screens. Click the ⟳ button to expand again; drag the tile to move.
Minimize to menu bar Minus button hides the window to the macOS menu bar (tray). Click the tray icon to bring it back.
Transparent, frameless No title bar; just the status card.

Scripts

Command Purpose
./start.sh Clean + run dev (recommended)
npm run dev Same, without cleaning
npm run build Build for production (renderer + Electron)
npm run lint Run ESLint

Stack

  • Electron — desktop window, tray, IPC
  • Vite — dev server and build
  • React 19 — UI
  • Tailwind CSS — styling
  • TypeScript — main, preload, and renderer

Keep your Backboard API in the corner of your eye.

About

Backboard.io Status App

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors