Skip to content

DonPage/DevWars-Bot

Repository files navigation

DevWars Twitch Bot & Interface

What is DevWars?

Two teams of three battle to produce the best work of their coding ability, taking the reigns of a single language each: HTML, CSS and JavaScript.

What is this repo?

There are two parts to this project:

  • bot - Allows people to join a language position through twitch chat. Example: !join js donpage. This will put you on a blue or red team Javascript position. The {donpage} is your c9 account name.
  • app - Using Web Starter Kit, Angular, and Firebase, this project main focus is performance and 3-way-binding between front-end and servers. Allowing the user to see open positions without a page reload while also available on mobile browsers.

Dev Notes

Made by: Don Page - divine_don (twitch) I've used Bootstrap and Foundation before but wanted to try something new, Web Starter Kit by Google.

How to Install:

The dependencies are:

Once you have that you can run this command:

$ sudo npm install

Note: If you get an ERR, make sure you have the latest version of npm. If you are having problems you can view the install file in the docs folder.

next, getting the twitch bot to work:

  • Create/Login to your twitch bot account and get your IRC password from here: http://twitchapps.com/tmi/
  • Create: bot/secret.js - and copy and paste the code below:
var twitchbot = require('./twitchbot.js');
var bot = twitchbot.create({
  name: 'XXXX',
  channel: 'XXXX',
  password: 'oauth:XXXX'
});
module.exports = bot;
  • Create: bot/fbsecret.js - and copy and paste the code below:
var Firebase = require("firebase");
var ref = new Firebase("https://XXXXXXX.firebaseio.com/");
ref.authWithCustomToken("XXXXAUTH_TOKENXXXX", function(error, authData){
  if(error){
    console.log("Firebase login Failed!", error);
  } else {
    console.log("Authenticated successfully with payload:", authData);
  }
});
module.exports = ref;

Once XXXXX information is filled out, now you can run the bot: make sure you are in the bot folder

$ node bot

How to Contribute

I will list what you need to know and what files are okay to edit when trying to contribute to different aspects of the project:

Design:

  • Sass - Make sure to have a good understanding of scss. Creating different .scss files inside the styles folder is okay, just make sure you @import then into main.
  • HTML - Basic understanding is required.
app/styles/main.scss
app/views/*.html

Front-end

  • Angular - Angular is the MVC framework chosen for this project. Intermediate understanding of how it works is needed to make changes.
  • AngularFire - Make sure you are up to date with the recent changes from 0.7.0 to 0.9.0. changelog.
  • jQuery - Basic understanding is required.
app/scripts/app.js

Back-end

  • NodeJS - Anyone that understands Javascript can edit.
  • Firebase - Intermediate understanding is required.
bot/bot.js

About

prototype/proof of concept twitch bot and webpage for DevWars

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published