Skip to content

siiddhantt/githitbox

Repository files navigation

🎯 GitHitBox

A fast, reusable GitHub profile hit counter that generates beautiful badge images

Python FastAPI License: MIT

🚀 Features

  • 🌍 Universal: Works for any GitHub username
  • 🎨 4 Badge Styles: flat, plastic, counter, for-the-badge
  • ⚡ Fast: Built with FastAPI
  • 💾 Persistent: Database storage (SQLite/PostgreSQL)
  • 🚀 Easy to Deploy: Works on any hosting platform

📖 Usage

Add to your GitHub profile README:

![Profile Views](https://githitbox.duckdns.org/badge/your-username)

Styles Available:

Style Example
Flat (default) Flat
Plastic Plastic
Counter Counter
For-the-badge Badge

💡 Tip: Add ?v=2 to bypass GitHub's image cache

🛠️ Local Development

git clone https://github.com/siiddhantt/githitbox
cd githitbox
pip install -r requirements.txt
python main.py

Visit http://localhost:3001/docs for API documentation.

🔌 API Endpoints

  • GET /badge/{username}?style={style} - Badge image
  • GET /count/{username} - JSON hit count
  • GET /stats - Global statistics
  • GET /health - Health check

⚙️ Configuration

Environment Variables:

  • DATABASE_URL - Database connection (defaults to SQLite)

Badge Styles:

  • flat - Clean, modern (default)
  • plastic - Rounded, glossy
  • counter - Digital display with dark theme
  • for-the-badge - Bold, rectangular

📝 License

MIT License - free to use for your projects!


Star this repo if you find it useful!

GitHub stars

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •