Code Monkey home page Code Monkey logo

shamebot's Introduction

ShameBot

License: MIT Code Climate Docker Automated build

About

Bot built with Botkit that embarrasses -in a friendly way- slack teammates who commit programming mistakes according to failed builds emitted by the CI bot.

Demo

demo-commands

Setup

API Keys

You will need a SLACK_TOKEN which identifies your bot with your slack team, and a GIPHY_API_KEY, which will enable ShameBot to send GIFs:

  • You can get your SLACK_TOKEN by creating a user bot for your team here.
  • You can get your GIPHY_API_KEY here.

Development

  1. Make sure to have a Slack Team, with ShameBot as a member.
  2. Clone and cd into this repository
  3. run npm install (or yarn install)
  4. Export the environment variables SLACK_TOKEN and GIPHY_API_KEY.
  5. run nodemon .

Docker

docker run -d --name=shamebot \
  --env SLACK_TOKEN=<your-slack-token> \
  --env GIPHY_API_KEY=<your-giphy-api-key> \
  sasalatart/shamebot

Contributing

  1. Fork this repository
  2. Create your branch from the develop branch (git checkout -b my-changes)
  3. Commit your changes using these emojis (git commit -am '<emoji> my changes message')
  4. Push your branch (git push origin my-changes)
  5. Create a new Pull Request

giphy-attribution

shamebot's People

Contributors

sasalatart avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

shamebot's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.