Contrib Cal v2 is a contribution tracker built around a Raspberry Pi Zero W. It shows your GitHub activity using LEDs and includes a web interface for easy setup and control. The project is open, hackable, and designed for anyone interested in building their own contribution calendar.

Take a look at my website!

Availability

This will soon be available to purchase as a kit from sellers like Elecrow and Tindie!

---

Sponsored by PCBWay

PCBWay provided the PCBs for this project. They offer PCB fabrication and 3D printing with quick turnaround and worldwide shipping.
Check out PCBWay.com if you want to order your own boards.

---

Features

• GitHub Sync: Shows your GitHub activity on an LED matrix.
• Weather Animations: Displays weather effects and temperature.
• Tailscale: Optionally connect your Pi to a Tailscale network.
• Syncthing: Optionally run a Syncthing node for file sync.
• Pi-hole: Optionally run Pi-hole for ad blocking.
• Customizable: Animations and logic are written in Python.
• DIY Build: Use a 3D-printed case and a custom PCB LED matrix.
• Web Interface: Configure settings and add-ons from your browser.

---

Hardware Files

• 3D Print Files: Available on Thingiverse at https://www.thingiverse.com/thing:7136260
• KiCad PCB Design Files: Located in the KiCad folder in this repository.
• PCBWay Order Zip: The PCBWay file.zip in this repo can be uploaded directly to PCBWay—just drag and drop it on their site to order your board.

---

Web Interface

You can manage most settings and add-ons through a simple web page hosted on the Pi.

---

Build Guide

• LEDs: 28x SMD5050 RGB addressable LEDs (SK6812 or similar)
• Microcontroller: 1x Raspberry Pi Zero W (Pi Zero 2 W may work, but not tested)
• Power Adapter: 5V step down buck convertor and usbc breakout board
• PCB: Can be ordered using the PCBWay file.zip mentioned previosly

You can substitute

---

Getting Started

See GettingStarted.md for step-by-step instructions on flashing, setup, and configuration.

---

Contributing

Pull requests and suggestions are welcome.
If you run into issues or have ideas, feel free to open an issue on GitHub.

---

Note on GitHub API Real-Time Updates

Contrib Cal v2 displays your GitHub activity as close to real-time as possible using the GitHub API. However, there may be delays in showing the most recent events due to how quickly GitHub updates and provides new event data. This is a limitation of the GitHub API itself and not an issue with this project's implementation.

---

Thanks for checking out Contrib Cal, Feel free to open up PRs!