Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 1.96 KB

README.md

File metadata and controls

40 lines (27 loc) · 1.96 KB
Raw

Slack Birthday Bot

The purpose of this bot is to send a message to your team's Slack when is someones birthday.

Setup & Deploy

Heroku

  1. Clone this repo to a desire location at your own computer
  2. Get your Incoming Webhook URL from Slack
  3. Save the url at configurations.json file and fill in the rest of the configurations as you like
  4. Set your birthdays list using the format FirstName LastName YY MM DD at the birthdays.txt file
  5. Create a blank app at Heroku
  6. Push your code to Heroku
  7. The bot was developed with the 2.2.6 version of ruby, any other versions may require changes.
  8. Run heroku addons:create scheduler:standard to add the Scheduler add-on to your deploy
  9. Run heroku addons:open scheduler to configure the scheduler
  10. Click Add a new job and type rake congratulate as the command
  11. Set frequency to Daily and choose the Time you want to be notified

Custom Server

  1. Clone this repo to a desire location at your own server
  2. Get your Incoming Webhook URL from Slack
  3. Save the url at configurations.json file and fill in the rest of the configurations as you like
  4. Set your birthdays list using the format FirstName LastName YY MM DD at the birthdays.txt file
  5. Run crontab -e to edit your crontab
  6. Add this line to the crontab and save it: 0 9 * * * cd /clone/location && /usr/local/bin/rake congratulate (replace /clone/location by the location where you cloned the repo)

Contributors

This project was originally created by Tiago Botelho, while he was an intern at jeKnowledge.

It was later revised by Diogo Nunes from EqualExperts and João Bernardo from jeKnowledge.

License

This project is licensed under the terms of the MIT license.