vladkens / ghstats

🤩📈 Self-hosted dashboard for tracking GitHub repos traffic history longer than 14 days.
MIT License
126 stars 2 forks source link

Add embed URLs #4

Open lawndoc opened 2 months ago

lawndoc commented 2 months ago

It would be nice if we could create embeds for showing repo stats within GitHub READMEs, personal websites, etc.

vladkens commented 2 months ago

Hi, @lawndoc

Tell me what kind of data you're interested in? Stars chart like star-history.com do or something else?

Should the whole list of repositories be private (like with basic auth), and only iframe / specific pages should be public?

lawndoc commented 2 months ago

As an MVP, the embed could just call the hosted URL and gets a static copy of whatever data is on the current dashboard configuration. Eventually, there could be additional "dashboards" with their own configs and static embed URLs but honestly just the one would be fine with me.

lawndoc commented 2 months ago

Or maybe instead of static HTML it could just be a rendered image. That would be flexible enough to put in a GitHub README

vladkens commented 1 month ago

Hi, @lawndoc. Rendered image (SVG) is good. But I need help understanding which images can be shown.

1) For example you can make a chart like on https://star-history.com. 2) You can make badges with visitors / starts count like at https://badgen.net/. 3) Something else?