🚧 This project is under construction 🚧
Note
The name comes from one of the API endpoint called stargazer (= all the people that starred a repo), combined with GH for GitHub initials
This project allows you to track some statistics of a GitHub repo using GitHub's Rest API. Currently, it tracks count of :
- ⭐ Repo's stars
- 🎯 Repo's issues
- 🔱 Repo's forks
- 🌿 Repo's branches
You also have the ability to easily add events
No authentication is needed.
Every time you will call the main program, 1 call to the API is made + 1 or more depending on how much branch your repo has (1 request made every 100 branches, which is the max pagination returned by the endpoint).
Important
The API rate limit is 60 call/hour so if you start the main program to many times and/or have too many branches on fetched repo, you might end-up being blocked for an hour
Theses are the languages/frameworks/libraries used.
Make sure you have node installed and the dotenv package.
Clone the repo and cd into it
git clone https://github.com/Axxiar/starGHazer.git
cd starGHazer/Rename .env.example file to .env
Edit .env and replace with the owner (REPO_OWNER) and name (REPO_NAME) of the repository you want to track
e.g. to track this repo : https://github.com/catppuccin/palette, the owner is "catppuccin" and the repo name is "palette", so you should have this as
.envfile :REPO_OWNER="catppuccin" REPO_NAME="palette"
Finally, start the main program and follow instructions
node starghzer.js- 🗝 Support for events
- 🗝 Setup config files and guide
- 🗝 Typescript rewrite
- 🗝 Support separated stats file to avoid large files
- 🔥 Visually select displayed year data
- 🔥 Terminal wizard for first setup
- 🔥 Deployment config and guide for linux based server using cronjobs
- ❓ Support for multiple days events
- ❓ More statistics
🗝: key feature 🔥: cool extra feature idea ❓: extra feature idea (wil probably not be added or at least not soon)
If you wish to contribute, feel free to do so ! You can fork and open PRs.