Giter VIP home page Giter VIP logo

bucket's Introduction

Bucket

Bucket is a chatterbot built for Slack using Ruby on Rails. It is a port of Dan Broger's fine xkcd-Bucket. As such, it is licensed under the GPLv3.

Build Status

Using Bucket

Installation

  1. Install ruby, using .ruby-version
  2. Install Postgres 9+ (I'm using 9.4.x right now)
  3. Run bundle install to install the dependencies.
  4. Copy config/database.example.yml into config/database.yml and set it up to match your database.
  5. Run rake db:setup to create your database.
  6. Run rake to test that everything works.
  7. Run rails s to start the server.

Deploying Bucket

Bucket works great with Pivotal Web Services or with Heroku. You will want a database service, such as ElephantSQL.

Slack Setup

Head to Slack's API page.

You will need an Outgoing Webhook. You will want a URL on which Bucket will listen, something like http://bucket.cfapps.io/messages. The route will need to be /messages.

Set the environment variables required in the production section of config/secrets.yml. These will be given to you by Slack.

Contributing to Bucket

What to work on

I have a public Pivotal Tracker project where you can see what I want to change with Bucket. Do you have other ideas? Open up an Issue on GitHub! I'm happy to help you throughout ideation and development.

Testing your changes

Run rake to test the specs with rspec, style with rubocop, and vulnerabilities with brakeman.

Changes to Bucket require matching specs. You'll find high-level specs in spec/requests and individual unit specs in their corresponding directories.

Want to try chatting with Bucket without needing to deploy or even setup Slack? Just run rake bucket and pretend it's IRC. Your username is CLI.

bucket's People

Contributors

michaelabon avatar markymarkmcdonald avatar harlie avatar

Watchers

James Cloos 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.