Giter VIP home page Giter VIP logo

showbot's Introduction

Stories in Ready Code Climate Issue Count

JBot

A sweet IRC bot with a web interface for Jupiter Broadcasting. Built on cinch and sinatra. It is a fork/evolution of Showbot, built for 5by5.

IRC Commands

To get a list of the available commands on your JBot instance, send it the follwing message once it is connected to an IRC network:

!help

(Make sure your JBot is allowed to send private messages on the IRC network!)

Setup and Customization

Prerequisites

Setup

These commands will get you setup to run the stable version of Showbot.

  • git clone https://github.com/rikai/Showbot.git
  • cd Showbot
  • bundle
  • foreman run rake db:migrate

If you would like to run the development version of Showbot, use the following commands instead:

  • git clone https://github.com/rikai/Showbot.git
  • cd Showbot
  • git checkout devel
  • bundle
  • foreman run rake db:migrate

Configuring JBot

For JBot to work correctly, you need to set up your .env file in the root of the project. Start by copying the .env.example file to .env and edit accordingly.

You also need to set up your cinchize.yml file. Copy cinchize.yml.example to cinchize.yml, and edit accordingly. To deactivate a plugin, comment out all lines related to that plugin in cinchize.yml. Don't forget to also update the connection settings and your bot's name.

NOTE: If you choose to configure a plugin it MUST be disabled, otherwise the bot will fail to start.

Lastly, you will need to create a data.json file. This file can be hosted by JBot's web server by putting it into public/, or can be hosted externally by setting the DATA_JSON_URL variable in .env to the URL. To learn more about data.json, read up on its documentation in docs/dev/DATA.JSON.md.

Launching Showbot

Website and the IRC Bot

$ bundle exec foreman start -f Procfile.local

Just the Website

$ bundle exec foreman start web -f Procfile.local

Just the IRC Bot

$ bundle exec foreman start irc -f Procfile.local

Modifying the CSS

Modifying showbot.scss requires that you start the rake sass:watch command. While this command is running, public/showbot.css will be overwritten with any changes that are made in showbot.scss. This annoying setup is necessary due to Bourbon not working well outside of the Rails asset pipeline.

Want to help out?

Check out our CONTRIBUTING doc to find out how to contribute to JBot.

Special Thanks

  • Special thanks to Rikai for reverse-engineering the setup steps for someone setting up Showbot from scratch.
  • To gouwens for implementing the clustered view.

JBot on the Internets

The Creation of Showbot

showbot's People

Contributors

mutewinter avatar rikai avatar cbojar avatar gouwens avatar kimroen avatar remnantstink avatar woodb avatar mikebeasterfeld avatar miawgogo avatar waffle-iron 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.