Skip to content

Latest commit

 

History

History
37 lines (32 loc) · 1.32 KB

README.md

File metadata and controls

37 lines (32 loc) · 1.32 KB
Raw

StatusBoard

A collection of components to render interesting real time data onto a status board screen. Very much a work in progress.

Currently functional boards:

  • Timezone Clock
  • PTV Departures Board
  • BOM Weather Radar

Planned improvements to functional boards:

  • Timezone Clock:
    • Alternate rendering mode as a flipboard-digital clock
    • Improved readability of analogue clock
    • am/pm indicator, or night/day (6am-6pm) indicator
  • BOM Weather Radar
    • Currently relies on the webpack dev server proxy to operate, needs to move to a production-ready proxy such as AWS

Planned future boards:

  • Current/forecast weather
  • BuildKite build statuses
  • Jira sprint status (either burndown/up or todo/inprogress/completed breakdown)
  • Bitbucket commit statistics

Running Statusboard

StatusBoard is a frontend-only create-react-app based application. Follows all the standard CRA build and run tools, most importantly:

  • npm run start
  • npm run test
  • npm run build

For the PTV board to work correctly, you'll need a developer ID and API key, which you can apply for here. Add these into a .env file as REACT_APP_PTV_DEV_ID and REACT_APP_PTV_API_KEY.