Skip to content

billdybas/gifatar

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

14 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

About

Twitter doesn't let you make your avatar a GIF.

But that doesn't mean your avatar can't be "animated"!

With gifatar, you can have your avatar update like a GIF over an extended period of time. When you look at your profile, you see a different frame each time, much like seeing the hands of a clock be in a different position when you glance up after a few hours โ€“ a slow web experience.

Run Your Own

  1. Make sure you have node and npm installed.
  2. Clone or fork this repo. git clone https://github.com/billdybas/gifatar.git
  3. Make a .env file. cp .env-sample .env
  4. Place the GIF you'd like to use in images/.
  5. Create a new Twitter app at https://apps.twitter.com/. Twitter will generate a Consumer Key and Consumer Secret. Make sure to also generate an Access Token and Access Token Secret at https://apps.twitter.com/app/<app_id>/keys. Put these in your .env.
  6. Fill in the other appropriate environment variables:
  • IMAGE_PATH: (string, required) Path of the GIF to use relative to the images/ directory
  • TWITTER_TIMEOUT: (number, optional, default: 1 minute) HTTP request timeout to Twitter
  • IMAGE_UPDATE_INTERVAL: (number, optional, default: 60 minutes) How often to update the profile image
  • VERBOSE: (boolean, optional, default: false) Whether to run in verbose mode
  1. npm install
  2. npm start

Deployment

If you need a quick and easy way to deploy this bot, check out now.

Resources

License

See LICENSE.md


Built during Brickhack 4 by Bill Dybas.