felixclack / starter-ruby-bot

A simple Beep Boop ready starter project in Ruby

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

starter-ruby-bot

Overview

A simple starting point for creating a Beep Boop hostable, Ruby based Slack bot.

Visit Beep Boop to get the scoop on the the Beep Boop hosting platform. The Slack API documentation can be found here.

Assumptions

  • You have already signed up with Beep Boop and have a local fork of this project.
  • You have sufficient rights in your Slack team to configure a bot and generate/access a Slack API token.

Usage

Run locally

bundle install
SLACK_TOKEN=<YOUR SLACK TOKEN> ruby ./bot.rb

Things are looking good if the console prints something like:

Connected <your bot name> to <your slack team> team at https://<your slack team>.slack.com.

Run locally in Docker

docker build -t starter-ruby .`
docker run --rm -it -e SLACK_TOKEN=<YOUR SLACK API TOKEN> starter-ruby

Run in BeepBoop

If you have linked your local repo with the Beep Boop service (check here), changes pushed to the remote master branch will automatically deploy.

Acknowledgements

This code is influenced by and utilizes the awesome https://github.com/dblock/slack-ruby-client project by @dblock.

License

See the LICENSE file for license rights and limitations (MIT).

About

A simple Beep Boop ready starter project in Ruby

License:MIT License


Languages

Language:Ruby 100.0%