jadjoubran/webdash

Webdash github stats

Open

#56 opened on Mar 29, 2018

View on GitHub
 (6 comments) (0 reactions) (0 assignees)HTML (1,547 stars) (72 forks)batch import
good first issueplugins

Description

Here's a draft design (still need to review it with @nicolesaidy, I'm sure she'll be able to fix the username/repo banner)

This would require a githubRepo option in webdash.json that can be automatically guessed by the installer (from package.json's repo)

If you'd like to work on this, please ping me and I'll be happy to help

Contributor guide

Tech stack
javascriptnodejsrest api
Domain
developer experiencebackendfull stack
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Node.jsGitHub API knowledgeWebdash configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
First, examine the current webdash.json configuration and its loading mechanism (likely in a config loader file). Then look at how the installer currently extracts repo info from package.json to auto guess the githubRepo. Next, explore the project's API layer to see how external services are integrated (if any). Finally, implement a GitHub API call to fetch stats like stars, forks, and open issues, and display them in the dashboard UI as per the provided design. Relevant files might include src/config.js, src/installer/index.js, and a new component for the stats display.