README.md

📢 Git Laugh Track 🎶

Play funny sound effects on every Git commit.
Turn boring commits into a party 🎉

🗺️ Architecture

flowchart TD
    User["👤 User (Developer)"]
    Git["🐙 Git Client"]
    PostCommitHook["🔗 post-commit Hook (hooks/post-commit)"]
    SoundFiles["🎵 Sitcom Laugh Tracks (~/.git-laugh-sounds/*.mp3)"]
    AudioPlayer["🎧 Audio Player (playsound, mpg123, afplay)"]
    Installer["⚡ global-install.sh"]
    Uninstaller["🗑️ uninstall.sh"]

    User --makes commit--> Git
    Git --triggers--> PostCommitHook
    PostCommitHook --selects random mp3--> SoundFiles
    PostCommitHook --calls--> AudioPlayer
    Installer --sets up hooks & sounds--> PostCommitHook
    Installer --copies--> SoundFiles
    Uninstaller --removes--> PostCommitHook
    Uninstaller --removes--> SoundFiles

Loading

🎥 Demo Video(Enable Sound 🔊)

git-laugh.vedio.mp4

✨ Features

• 🔊 Play a random .mp3 from your sound library on git commit
• ⚡ Works across Linux, macOS, Windows (via WSL/terminal)
• 🎛 CLI commands to play, add, and list sounds
• 🔗 Easy setup via global Git hooks

📦 Installation

Clone the repo and install it locally:

1. Clone the repository

git clone https://github.com/eleven-dev-cafe/git-laugh-track.git
cd git-laugh-track

2. Install dev dependencies:

pip install -r requirements.txt

3. Install the CLI command git-laugh

pip install .

You can also uninstall the CLI (if you’ve laughed enough)

pip uninstall git-laugh-track

🔊 Adding Sounds

Place .mp3 files into your /sounds directory

• Default: ~/.git-laugh-sounds/

Or add via CLI:

git-laugh add <path-to-sound>

🎮 Usage

Once installed, you can use the CLI tool:

Setup Git hooks and sounds for laugh sounds

git-laugh install       

Remove Git hooks and Sounds

git-laugh uninstall

Play a random laugh sound on each commit..

git-laugh play 

Git workflow

• Run git commit -m "fix bug" → plays a random sound 🎶
• Run git push → plays another random sound(soon...)

📜 License

This project is licensed under the BSD 3-Clause License.

👨‍💻 Developer

Gyarsilal Solanki

🤝

Need Help! in installation, Join us:

You can also discuss your ideas, share feedbacks, and coordinate contributions.

💡 Inspiration

Because coding is serious business… but your commits don’t have to be 🤣
If you find this project helpful, consider giving it a ⭐ to support!