https://github.com/documenso/stargrazer

A simple tool to poll and save GitHub Repo data like Stars and Forks and other metrics for displaying in a chart.
https://github.com/documenso/stargrazer

Last synced: 3 months ago
JSON representation

A simple tool to poll and save GitHub Repo data like Stars and Forks and other metrics for displaying in a chart.

• Host: GitHub
• URL: https://github.com/documenso/stargrazer
• Owner: documenso
• License: mit
• Created: 2023-08-12T11:56:05.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-12T10:45:08.000Z (5 months ago)
• Last Synced: 2024-07-12T01:50:41.725Z (4 months ago)
• Language: TypeScript
• Homepage:
• Size: 109 KB
• Stars: 4
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# StarGrazer - GitHub Stats Collector/ Aggreator

```

🦺 This is experimental code, that has not been tested extensively.

```

- We are running this on render.com

- One database

- One webservice

- One cronjob service

- We run this once a day, but aggregate to monthly so far

- Forks and Merges sadly can't be retrieved for older dates and tracking will start in August 2023

- Feel free to suggest changes/ addition, we can't guarantee how time we will put into this

- Also feel free to use, but please mind that this is not thoroughly tested code

# Endpoints

- /api/poll: Trigger datapoint collection for this moment

- /api/stat: Get a monthly aggregated timeline of previously collected stats. Highest value for month is used.

## Example Data for /stats:

```

{"2023-8":{"stars":2465,"forks":150,"openIssues":66},"2023-7":{"stars":2250,"forks":0,"openIssues":0},"2023-6":{"stars":2070,"forks":0,"openIssues":0},"2023-5":{"stars":1260,"forks":0,"openIssues":0},"2023-4":{"stars":90,"forks":0,"openIssues":0},"2023-3":{"stars":0,"forks":0,"openIssues":0}}

```