Skip to content
Open {re}Source
Articles

Repobeats: GitHub README analytics

2 min read
Julien Déramond
Julien Déramond
Open {re}Source • Bootstrap • Orange

Repobeats is a tool that provides analytics of a GitHub repository that can be embedded in any Markdown file; including its README file.

It is completely free and maintained by axiom.com, but does not seem to be an open-source project as it is not referenced in github.com/axiomhq.

This service allows to give a visual representation of the activity of your GitHub repository:

  • the number of contributions in the last 30 days
  • the number of opened/closed issues ratio with an associated bar chart of the past month
  • the number of PRs opened with an associated bar chart of the past month
  • the number of commits with an associated bar chart of the past month
  • the top contributors with their GitHub green square activity; their contribution heatmap

It can be a great way to show the activity of your GitHub repository and encourage people to contribute, but also to celebrate your top contributors.

Behind the scene, Repobeats uses public data available on GitHub.

Installation

Installing Repobeats requires a GitHub account.

To install Repobeats, it is pretty straightforward:

  1. Go to https://repobeats.axiom.co/
  2. Login with your GitHub account
  3. Select the owner and repository you want to analyze

And that’s it! You will get a URL like ours that you can use in your README file or any Markdown file:

// Add the following to your README.md to embed Repobeats
![Alt](https://repobeats.axiom.co/api/embed/da1c940f0135aece8b9942f518b44dacc39bd9ce.svg 'Repobeats analytics image')

Rendering

Here is what it looks like for our openresource.dev GitHub repository:

Alt

And here is the same kind of data, but on a more active repository like freeCodeCamp:

freeCodeCamp/
freeCodeCamp freeCodeCamp.org's open-source codebase and curriculum. Learn to code for free.

Alt

freeCodeCamp is using it in the “Contributing” section of their README file and it looks great!

We can see right away that this repository is very active with a lot of contributions, issues, PRs, and commits.

Tags: