Octo-Juggler 🤹

Gamify your GitHub Profile!

Why? • How to Use • Deployment • Collaboration

GitHub profiles can be a bit... static. Octo-Juggler adds a dynamic, retro-arcade style badge to your README. The Octocat juggles balls representing your open source contributions from the past week.

More Repos = More Balls = More Fun!

It's a fun way to visualize your weekly activity and add some life to your profile.

1. Insert Coin: Log in securely with your GitHub account at octocat.yups.me.
2. Get Your Badge: Copy the generated Markdown snippet.
3. Paste & Play: Add it to your profile README.md.

Example snippet:

[![Octo Juggler](https://octocat.yups.me/badge/YOUR_USERNAME)](https://octocat.yups.me/stats/YOUR_USERNAME)

This project allows you to host your own instance.

• Docker & Docker Compose
• A GitHub OAuth App (Callback URL: http://YOUR_DOMAIN/auth/github/callback)

1. Clone the repo

   git clone https://github.com/JaviLopezG/octocat.git
   cd octocat

2. Configure Environment Copy .env-example to .env and fill in your credentials.

   cp .env-example .env
   # Edit .env with your GITHUB_CLIENT_ID, GITHUB_CLIENT_SECRET, etc.

3. Run with Docker

   docker-compose up -d

4. Reverse Proxy (Optional) Use the provided Caddyfile-example to set up Caddy as a reverse proxy with automatic HTTPS.

We need YOU! The current pixel art is "programmer art". If you have pixel art skills and want to contribute better sprites (eyes, mouths, backgrounds...), please:

1. Fork this repo.
2. Check the assets/ folder structure.
3. Send a Pull Request!
4. For questions or ideas, open a Discussion or Issue.

For private matters, contact [email protected].