keep-starknet-strange/madara-tsukuyomi

Feat: Show progress of docker pull

Open

#30 opened on Aug 21, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (16 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (21 stars)
PR merge metrics
 (PR metrics pending)

Description

docker.modem.followProgress has an onProgress event listener. We can use that to detect the progress of the Docker installation and show it to the user. Currently, we just show a simple infinite loader.

The progress event fired by Dockerode isn't a simple event with progress percentage, instead it contains the actual logs you see during docker pull. So we need to come up with a neat way to show the progress to the user. Some ideas

  • Calculate the total progress % using some formula
  • Show a dialog box which shows the logs as it is from the user

Contributor guide

Research direction
Explore Dockerode's followProgress method and design a UI component to display progress logs. Consider options like calculating percentage from status messages or showing a log dialog.
Tech stack
typescriptnodejs
Domain
desktop
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70