Story
What is this project?
The Contrib Cal is a physical, glowing calendar that sits on your desk and visualizes your GitHub contribution graph in real life. Powered by a Raspberry Pi Zero W, it's more than just a light-up toy; it's a fully open-source platform that can also run self-hosted software like Pi-hole, Tailscale, and Syncthing with a single click.
Features & Design
-
Real GitHub Integration: Connects to the GitHub API to light up an 84-LED grid based on your commit history.
-
Hackable MicroPython Firmware: Easy to modify and add new features like weather animations.
-
Web Interface: Control everything from a simple browser-based UI.
-
Custom PCB & 3D-Printed Case: Designed for a clean, professional look. All design files are open-source.
-
One-Click Software Deployment: Transform the device into a server for ad-blocking, VPN, or file-syncing.
How does it work?
The Raspberry Pi Zero W runs a Python script that periodically fetches your contribution data from GitHub. It then maps this data to a grid of NeoPixels (WS2812B LEDs), lighting them up green for commits. A web server allows you to change settings without touching the code.
Step-by-Step Tutorial
Full instructions, code, and design files are available on the GitHub repository: https://github.com/Logan-Fouts/CCal_V2 or on instructables https://www.instructables.com/Contrib-Cal-Github-Desk-Gadget/
For a visual guide, watch the complete assembly video on YouTube: https://www.youtube.com/watch?v=vU_tsjnP8HE
Key Steps:
-
Source the Components: Gather the PCB, Pi Zero, LEDs, and hardware.
-
Solder the LEDs: Carefully solder the LED matrix to the custom PCB.
-
Print the Case: 3D print the face and back plates.
-
Assemble: Install heat-set inserts, screw in the PCB and Raspberry Pi, and wire up the power and data lines.
-
Software Setup: Flash the MicroSD card and get it connected to your wifi, follow the getting started guide on github, and configure your GitHub settings.
