anuraghazra/github-readme-stats

Add card generation website

Open

#1761 opened on May 18, 2022

View on GitHub
 (18 comments) (11 reactions) (0 assignees)JavaScript (79,424 stars) (33,282 forks)batch import
:star: top featurecore-teamdocumentationenhancementhacktoberfesthelp wanted

Description

Is your feature request related to a problem? Please describe.

I think it would be nice to have a card creation website for this project. This would allow users to generate the markdown code for our card using a simple interface. @anuraghazra, I vaguely remember you already did some work on this. No pressure, I just created this issue so we can track this feature.

Example

I think something like https://github-readme-streak-stats.herokuapp.com/demo would be amazing! Unfortunately, this example is coded in PHP. For future maintainability, I however think using a framework like React with https://mui.com is the better choice (see https://github.com/DenverCoder1/github-readme-streak-stats/tree/main/src/demo).

Contributor guide

Tech stack
javascriptreact
Domain
frontend
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
ReactMaterial UIHTML/CSS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the existing codebase for any previous attempts or partial work. Review the demo from github readme streak stats (https://github.com/DenverCoder1/github readme streak stats/tree/main/src/demo) as a reference. Explore using React with Material UI to create a single page application for card generation. The new website should allow users to input parameters and generate markdown code for the GitHub stats cards.