https://github.com/vsnthdev/twitter-banner

Automatically 🤖 updates Twitter banner ⌚ every few minutes.
https://github.com/vsnthdev/twitter-banner

actions artwork github-actions puppeteer social-media twitter

Last synced: about 1 month ago
JSON representation

Automatically 🤖 updates Twitter banner ⌚ every few minutes.

• Host: GitHub
• URL: https://github.com/vsnthdev/twitter-banner
• Owner: vsnthdev
• License: gpl-2.0
• Created: 2021-12-25T10:52:48.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-08-06T16:18:04.000Z (over 2 years ago)
• Last Synced: 2023-03-07T13:46:12.708Z (almost 2 years ago)
• Topics: actions, artwork, github-actions, puppeteer, social-media, twitter
• Language: JavaScript
• Homepage:
• Size: 2.09 MB
• Stars: 8
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


    



Automatically 🤖 updates Twitter banner ⌚ every few minutes.



    

        

    

    

        

    

    

        

    

    

        

    



Unlike my previous approach where I used Redis + Digital Ocean + Docker to update the Twitter profile banner, this approach does not need to be deployed separately & uses Github Actions instead. Read how it works for more information.

> Tweet me @vsnthdev, I would love to know your opinion/experience on this project 😍

## ✨ Usage Guide

You can easily have this project change your Twitter profile's cover image by following the below steps:

1. Fork [this repository](https://github.com/vsnthdev/twitter-banner/fork)

2. Set the [below environment variables](#%EF%B8%8F-environment-variables) as repository secrets

3. Enable workflows on the forked repository

4. Update the banner image at [`data/background.png`](https://github.com/vsnthdev/twitter-banner/blob/main/data/background.png)

5. Optionally update the stylesheet at [`data/styles.css`](https://github.com/vsnthdev/twitter-banner/blob/main/data/styles.css)

6. Select the "Banner Update" workflow & click on "Run workflow"

## 💡 How It Works

## 🏕️ Environment Variables

| Variable | Description | Default Value |

| -------- | ----------- | ------------- |

| `BACKGROUND_IMAGE` | Background image name | `background.png` |

| `STYLESHEET_NAME` | The CSS filename | `styles.css` |

| `NO_FOLLOWERS` | Number of followers to get images of | `4` |

| `TWITTER_USERNAME` | Your Twitter username |  |

| `TWITTER_API_KEY` | Twitter API key from developer dashboard |  |

| `TWITTER_API_SECRET` | Twitter API secret from developer dashboard |  |

| `TWITTER_ACCESS_TOKEN` | Twitter API access token with read/write permissions |  |

| `TWITTER_TOKEN_SECRET` | Twitter API token secret with read/write permissions |  |

| `IMAGES_CONTAINER_ID` | ID of the div where images will be attached | `images` |

## 📋 License

> The **twitter-banner** project is released under the [GPL v2](https://github.com/vsnthdev/twitter-banner/blob/main/LICENSE.md). 
 Developed & maintained By Vasanth Srivatsa. Copyright 2022 © Vasanth Developer.



> vsnth.dev  · 

> YouTube @vasanthdeveloper  · 

> Twitter @vsnthdev  · 

> Discord Vasanth Developer