badges/shields

Badge request: Particle Library installs

Open

#1274 opened on Nov 15, 2017

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

Description

Goal is to add an installs badge to display the number of downloads/installs for particle.io libraries. The API endpoint is here and requires authentication via a personal access-token.

I'd like to take a stab at it but am not sure how to really integrate/require credentials. I think there is a tutorial somewhere, or I'll dive into the source on one of the other badges that requires them. Any help/input would be appreciated!

Contributor guide

Tech stack
javascriptnodejsrest api
Domain
backendapi
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.
mostly clear
Prerequisites
Familiarity with shields codebaseAPI authenticationNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine existing badge implementations that require authentication (e.g., GitHub badges) for patterns. Look at the shields.io codebase, particularly the 'services' directory, to understand how to add a new service. Implement a service for Particle library installs using the provided API endpoint, ensuring secure handling of personal access tokens via environment variables. Consult the shields documentation for adding services and refer to any linked PRs or comments for additional context.