[go: up one dir, main page]

Skip to content

elliotreborn/github-stars

Repository files navigation

logo

Github Stars

✨repository's star growth chart
Explore Demo »

report bug · request feature · keep touch (Discord)

Test Build Dependencies Dev Dependencies License

Demo

Introduction

Inspired by the timqian/star-history.
The project extension implements the comparison of star trend data for multiple GitHub repository in the technology stack. You can easily add the technology stack-related repositories you understand and download chart image.

Quick Start

configure your REACT_APP_GITHUB_TOKENS environment variable in .env.development

npm install
npm start

About Cache

This project can use full functionality without remote caching. However, it is strongly recommended that users build their own caching service. Reduce the frequency of using github token and avoid causing trouble to github.com. Just configure it in .env*:

REACT_APP_CATCH_POST (submit cache data API).
REACT_APP_CATCH (get cache data api).
REACT_APP_CATCH_CN (get cache data api in China)

You can see how these environment variables are used.

About Github Token

Data for each repository star history requires a maximum of 30 github api requests. There can only make up to 60 requests per hour without github authentication. So we need to guide the user OAuth to get the token for requests, each user's github token can make up to 5000 requests per hour. more information.

At present, this project uses the very simple netlify.com oauth solution, does not request any scope permissions. And there is no remote storage token, only local cache.