duhruh/dashboards repository overview

⁠qa-dashboards

⁠Quickstart

Pre-reqs:

• Docker
• Node

Install deps:

yarn install

Bring up the backend:

docker-compose up -d --build

Bring up the frontend:

yarn start

⁠Demo

• GET localhost:9090/api/dashboard/1
• Copy the output and change a pending status to pass or fail
• Submit the new data via PUT localhost:9090/api/dashboard/1
• The UI will update automatically

⁠Architecture

QA Dashboards consists of the following components:

• Redis: Used as a state store
• Backend: Go application that exposes an API to get/mutate dashboard data and communicate with Redis
• Frontend: React application that displays information gathered from the backend

The API is simple:

• HTTP GET /api/dashboard/<id> retrieves a dashboard
• HTTP PUT /api/dashboard/<id> updates a dashboard
• /live/dashboard/<id> provides live updates using WebSockets

⁠TODO:

1. Expand the API to include more useful data (e.g Links to Jenkins Jobs/GH commits etc...)
2. Expand the API to track history of each job
3. Expand the UI to display more information when a status is clicked. For example, trend in the last 7 days, date of last success, date of last failure, links to more detail etc...)