badges/shields

Badge request: Particle Library installs

Open

#1.274 geöffnet am 15. Nov. 2017

Auf GitHub ansehen
 (8 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (22.337 Stars) (5.423 Forks)batch import
good first issueservice-badge

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
Familiarity with shields codebaseAPI authenticationNode.js
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40
Research-Richtung
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.