Git Product home page Git Product logo

grimesbot's Introduction

grimesbot

GrimesBot is a slackbot based upon the Travis-ci NorrisBot. It's a no nonsense task orientated Zombie killing 357 magnum wheeling kick ass survivour.

Rick Grimes face

GrimesBot is loaded with Rick Grimes sage like quotes which are emparted every time that someone says “Rick Grimes” in the chatroom.

Installation

As simple as installing any other global node package. Be sure to have npm and node (>= 0.10 version, or io.js >= 1.0) installed and launch:

$ npm install -g grimesbot

Running the GrimesBot

To run the GrimesBot you must have an API token to authenticate the bot on your slack channel. Once you get it (instructions on the next paragraph) you just have to run:

BOT_API_KEY=somesecretkey grimesbot

Getting the API token for your Slack channel

To allow the GrimesBot to connect your Slack channel you must provide him an API key. To retrieve it you need to add a new Bot in your Slack organization by visiting the following url: https://yourorganization.slack.com/services/new/bot, where yourorganization must be substituted with the name of your organization (e.g. https://loige.slack.com/services/new/bot). Ensure you are logged to your Slack organization in your browser and you have the admin rights to add a new bot.

You will find your API key under the field API Token, copy it in a safe place and get ready to use it.

Configuration

The GrimesBot is configurable through environment variables. There are several variable available:

Environment variable Description
BOT_API_KEY this variable is mandatory and must be used to specify the API token needed by the bot to connect to your Slack organization
BOT_DB_PATH optional variable that allows you to use a different database or to move the default one to a different path
BOT_NAME the name of your bot, it’s optional and it will default to norrisbot

Launching the bot from source

If you downloaded the source code of the bot you can run it using NPM with:

$ npm start

Don't forget to set your BOT_API_KEY environment variable bedore doing so. Alternatively you can also create a file called token.js in the root folder and put your token there (you can use the token.js.example file as a reference).

License

Licensed under MIT License. © Luciano Mammino.

grimesbot's People

Contributors

worfinator avatar

Watchers

James Cloos avatar  avatar

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.