Skip to content

SantiiRepair/git-receipt

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Github Receipt 🧾

A receipt-style Github receipt designed to work perfectly as an embeddable iframe, inspired by git-receipt.com.

The Story Behind This Project

I discovered git-receipt.com and absolutely loved the concept of displaying Github stats in a creative, receipt-style format. However, when I tried to embed it on my personal website as an iframe, it didn't work as expected.

Important

According to the official website, the original repository was at gitreceipt, but it appears the creator has either deleted their profile or changed their username, making the original project inaccessible.

So I decided to build my own version from scratch that:

  • Maintains the aesthetic I loved from the original
  • Works perfectly as an embeddable iframe
  • Includes smart caching to handle Github API limits
  • Is actively maintained and easy to deploy

Features

  • 🖼️ Iframe Ready - Built from the ground up to work perfectly when embedded
  • ⚡ High Performance - Smart caching with Ristretto for fast responses
  • 📊 Real-time Metrics - Cache statistics and performance monitoring
  • 🔐 Github API Support - Works with or without authentication tokens
  • 🚀 Easy Deployment - Simple setup with Tailscale Funnel or any cloud platform

Quick Start

Prerequisites

  • Go 1.24 or higher
  • Github token (optional, for higher API limits)

Usage

To use the Github receipt in your profile, simply embed it using the following format:

![SantiiRepair's Github stats](https://santiirepair.tail012146.ts.net/SantiiRepair)

or to use it on your website as an iframe:

<iframe
  src="https://santiirepair.tail012146.ts.net/:username"
  width="400"
  height="600"
  frameborder="0"
  style="border: 1px solid #e1e4e8; border-radius: 6px;"
>
</iframe>

Replace :username with the Github username you want to display. For example:

<iframe
  src="https://santiirepair.tail012146.ts.net/octocat"
  width="400"
  height="600"
  frameborder="0"
>
</iframe>

Showcase

SantiiRepair's Github stats

Or if you want to see what it looks like, let's look at it using the Octocat as an example.

About

Generate a receipt-style summary of your Github profile

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages