Skip to content

JasonBernert/orestar-bot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

💰 ORESTAR Bot

ORESTAR bot is a Slack bot that delivers Oregon campaign finance data from the ORESTAR database. ORESTAR bot interfaces with HackOregon's Behind The Curtain API. You can learn more about the API here. ORESTAR bots is built with Botkit.

Getting Started

  1. Download or clone ORESTAR bot: git clone https://github.com/JasonBernert/orestar-bot.git
  2. Install dependencies: npm install
  3. Create a new bot integration for your team here. Though you can name the bot whatever you'd like, @orestar will be the name of the bot in this documentation.
  4. Copy the API token that Slack gives you for your new bot.
  5. Run ORESTAR bot using the token you just copied: token=REPLACE_THIS_WITH_YOUR_TOKEN node orestar_bot.js
  6. ORESTAR bot should be online! Within Slack, send it a quick direct message to say hello. It should say hello back!

Type: /invite @orestar to invite orestar bot into a channel.

What can ORESTAR bot do?

ORESTAR bot responds to the following phrases:

Help

  • Help return a list of phrases and responses.

General responses

  • Hello will greet you with your name, if it has a nickname saved for your user.

  • Call me will save a nickname to user name.

  • What is my name? will respond with user's nickname.

  • Who are you? will respond uptime and hostname data.

  • Shutdown will shut down the bot.

Campaign finance responses

  • top individuals gets the total contributions from the top 5 contributing individuals in all of Oregon.

  • top business gets the total contributions from the top 5 contributing businesses in all of Oregon.

  • top committees gets the total contributions from the top 2 contributing committees in all of Oregon.

  • search [candidate name] gets candidate info.

More coming soon...

About

A Slack bot delivering Oregon campaign finance data

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published