nerd-bot is a bot built with the goal to automate jokes and humor mainly popular within the developers community. Most times we developers/programmers get tired writing code and since https://www.slack.com is where most of our interaction occurs, it's not uncommon to just chat with a bot cracking jokes as your teammates might still be busy, nice right? Nerd-bot scraps the web and returns you random jokes in form of images or text given the right commands in slack.
- You will need to create a new slackwork space
- Head over to http://slack.com/services/new/bot
- Give your bot a name
- Configure it as you desire and save integration
- Save the SLACK_API_TOKEN string that starts with
xoxb
, you will need it later - Head over to slack and you will see your bot
- Clone this project locally
- Run
git checkout feat/slack-bot
in the terminal - Run
bundle
to installGems
and their dependencies. - Create a
.env
file and paste your earlier saved SLACK_API_KEY - Check the
.env.example
file on how to do it - Run
bundle exec rackup
to start it the server - Your bot should be working by now
- Test have been built using
Rspec
as Test Runner and Fixture - Test Coverage by
SimpleCov
- Run
rspec
to run the test - On windows run
open coverage/index.html
for code coverage - On unix based systems run
xdg-open coverage/index.html
for code coverage
- The bot can be invited into other workspace or direct messaged
- Use
@bot_username jokes_image
to get programming jokes as images where@bot_username
is the name of your bot - Use
@bot_username jokes_text
to get programming jokes as texts - Use
@bot_username say_hello
to greet the bot - The
@bot_username
is optional while talking in a Direct message with the bot - Type
@bot_username
help
for the above commands - Enjoy
👤 Emmanuel Okello
- GitHub: @oxenprogrammer
- Twitter: @ox_emmy
- LinkedIn: LinkedIn
Contributions, issues, and feature requests are welcome!
Give a ⭐️ if you like this project!
This project is MIT licensed.