Skip to content

README.md

Latest commit

 

History

History
37 lines (27 loc) · 1.26 KB

README.md

File metadata and controls

37 lines (27 loc) · 1.26 KB
Raw

CoverageMonitor

CoverageMonitor displays a Go repository and its test coverage

Prereqs:

  • docker
  • make

To run:

  • make docker (due to node-modules, might take 5-10min)
  • go to localhost:8321 (preferably with chrome)

What it looks like:

Select a github repository

image

Select a file

image

Click Run Tests

image

What's happening on the back end:

When the user enters the repo, the back end uses github APIs for

  • Meta info (number of watchers and repo language)
  • Repo Files
  • File content

collects the needed information and replies with the acquired data to the front end (api calls are run in parallel, so the response is almost immediate).

When the user clicks RUN TESTS, the back end clones the repo, runs go test -coverprofile on it, parses the results and replies to the front end (takes ~1 sec for /google/uuid due to cloning and testing).

Technologies Used

  • React with TypeScript (tsx) + CSS
  • Go
  • Nginx
  • Docker