badges/shields

Badge request: npm installed size

Open

#1,701 opened on May 23, 2018

View on GitHub
 (4 comments) (2 reactions) (0 assignees)JavaScript (22,337 stars) (5,423 forks)batch import
good first issueservice-badge

Description

I see there is already a badge for bundle phobia that displays the bundle size which is useful for front-end packages like react.

I would like to add a badge for package phobia that displays the total npm install size plus dependencies, which is useful for backend packages such as express or desktop packages like electron.

Right now I'm just redirecting to shields but I had a suggestion to get put this on shields.io

Would you accept a PR if I created one? 😄

Contributor guide

Tech stack
javascript
Domain
developer experiencetooling
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
Node.jsExpress.jsShields badge API patternsExternal API integration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The contributor can refer to the existing bundlephobia badge (issue #941) as a pattern. They should explore the shields codebase, particularly the 'services/' folder, to understand how badge endpoints are registered. The main task is to create a new endpoint that queries the packagephobia API and formats the response as a badge. Additionally, the contributor may want to read through the issue comments to check for any maintainer feedback or constraints.