tnws / glitterbot

✨ A bot to improve team morale by posting Glitterplaatjes to Slack

Glitterbot

Your teams daily source of motivation

Glitterbot is a free and open source Slack bot. The bot improves your team's productivity by boosting your teams morale each morning. Glitterbot accomplishes this morale boost by posting a new Glitterplaatje at the start of each day.

For more information, visit the Glitterbot website.

After adopting Glitterbot, how much more productive is your team?

Glitterbot has greatly improved our teams morale. It makes our employees feel like their work has a higher purpose. Each new Glitterplaatje gives us a way to recognize our team members for a job well done.

- Bert-Jan Verwer

Glitterbot is polluting the chat.

- Ryan Warsaw

I love Glitterbot! Waking up every day and receiving my daily dose of motivation from Glitterbot always boosts my productivity 🤔🙏

- Kailan Blanks

What Glitterbot looks like

Usage

You can host the Glitterplaatjes on your own web server, or use the Appmantle Glitter CDN as the source for the images. The Glitter CDN will always be up-to-date allowing you and your team to receive the latest and greatest Glitterplaatjes.

This bot is written in JavaScript and requires Node.js to run.

Setup

1. Create a new coming webhook on slack and select the channel you want your Glitterplaatjes to be send to
2. Clone Glitterbot to your own machine
3. Install all dependencies by running npm install
4. Start the bot using node glitterbot.js --webhook [URL], where [URL] the incoming webhook you just made.

Using your own images

If you don't like the Glitterplaatjes (What?!), Glitterbot can also send your team your own custom images.

1. Replace the images in the public folder with your own images. Make sure to maintain the existing folder structure. Place images meant for specific days in the folders for these days (public/mon for monday, public/tue for tuesday). Place generic images that could be sent on any morning in the public/generic folder. Images should not be larger than 2MB, otherwise they won't automatically expand in Slack. To automatically remove bigger images, set removeBig to true in images.js.
2. Run node images.js to generate a new images.json for your images.
3. Upload the images.json file and all images to your own server.
4. Change the source of the image host to your own server using the --source option.

Configuration

You can add these options when running Glitterbot to change settings.

Option	Usage
-w, --webhook <url>	Required: The URL of your incoming Slack webhook. You can configure these for in the Slack App Directory
-i, --instant	When using this flag, the bot will instantly send an image to your Slack without starting a Cronjob.
-c, --cron [cron]	CRON string used for scheduling messages (default: 00 09 * * 1-5)
-s, --source [url]	The path to where images.json and all images are hosted. By default this is our Glitter CDN.
-h, --help	Output usage information

Contributing

Adding new Glitterplaatjes

1. Fork the repository on Github.
2. Clone the repo to your own machine.
3. Add your own Glitterplaatjes to the correct folders. Images should not be larger than 2MB, otherwise they won't automatically expand in Slack. To automatically remove bigger images, set removeBig to true in images.js.
4. Install dependencies by running npm install.
5. run node images.js to generate an updated images.json with your new Glitterplaatjes.
6. Commit these changes to your own branch.
7. Push your work back to your fork on GitHub.
8. Submit a pull request to our repository.

Improving code

At Appmantle, we're always open to outside contributions to our projects. If you've ran into a bug or have found any code or documentation to improve, feel free to make a pull request with a bugfix or other improvements. If you don't know how to fix a bug yourself, just open a new issue and we'll try to fix it.