Skip to content

sanaysarthak/git-laugh-track

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Git Hook - Sitcom Laugh Track! πŸ˜‚

Bring laughter to your commits with Git Laugh Track.

A Git hook that plays a sitcom laugh track every time you commit code.

Table of Contents
  1. Overview
  2. Architecture
  3. Demo
  4. Run Locally
  5. How to Use
  6. Tools Used

πŸ“– Overview :-

Git Laugh Track is a fun and lightweight tool that adds a sitcom laugh track to your Git workflow. Every time you make a commit, a random laugh track sound will play, bringing a bit of humor and joy to your development process.

Key features include:

  • Plays a random sitcom laugh track on every Git commit.
  • Easy to install and uninstall.
  • Works with most popular audio players (paplay, mpg123, afplay).
  • No dependencies beyond standard Unix tools and an audio player.
  • Easily customizable: Add your own MP3 files to personalize the laugh track experience.

πŸ—ΊοΈ 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 (paplay, mpg123, or 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 (Enable Sound πŸ”Š) :-

demo-git-laugh-track.mp4

πŸ’» Run Locally :-

Installation

  1. Clone or download this repository to your local machine.
git clone https://github.com/sanaysarthak/git-laugh-track.git
  1. Navigate to the project directory.
 cd git-laugh-track
  1. Run the global installer to enable the laugh track for all new repositories:
bash global-install.sh

πŸ•ΉοΈ How to Use :-

Step 1: Make a Commit

Use Git as you normally would. After each commit, a random laugh track will play:

git commit -m "commit message"

Step 2: Enjoy the Laugh Track

If your system has a compatible audio player, you'll hear a sitcom laugh track after each commit.

Step 3: Uninstall (Optional)

To remove the laugh track hook and all related files from your system:

bash uninstall.sh

🧰 Tools Used :-

This project uses the following tools and scripts:

  • Bash scripts (global-install.sh, uninstall.sh) for setup and removal.
  • Git hooks (post-commit) for triggering the laugh track.
  • Standard Unix utilities (find, shuf, etc.).
  • Audio players: paplay, mpg123, or afplay (one required).

About

A Git hook that plays a sitcom laugh track every time you commit.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages