gifhub

README

gifhub

📈 Create GIFs from user's GitHub activity graph

Go Dependencies

No non-Go dependencies required, so the binary is cross-platform!

• fogleman/gg: 2D graphics library
• urfave/cli: CLI framework

How to use

1. If your GitHub profile does not yet display activity overviews, enable it

2. You can run gifhub in 2 ways:

If you already have Go

# Install the binary and its dependencies
go get github.com/camilogarcialarotta/gifhub

# Then run the CLI with a GitHub handle
gifhub camilogarcialarotta

The application will generate a GIF named after the user inside ./out
For more information on available flags, run gifhub --help

If you don't want to install Go

Build and run a Docker container with the app. Requires Docker.

First, clone the repository and build the image

git clone https://github.com/CamiloGarciaLaRotta/gifhub.git
cd gifhub

docker build . -t gifhub

Then, create a directory of your choice to store the output GIF.
Run the container with the created directory mounted to /app/out

mkdir out
docker run -t \
  -v $(pwd)/out:/app/out \
  gifhub camilogarcialarotta

The application will generate a GIF named after the user inside ./out
For more information on available flags, run gifhub --help

Credits

Special thanks to:

• bclindner for the name idea
• DestructiveReasoning for math help and testing on Linux distros
• erickzhao for testing on OSX