trollbox v0.0.20

trollbox

Instant trollbox using Firebase.

Demo

https://lab.miguelmota.com/trollbox

Install

npm install trollbox

Instructions

1. Create a new Firebase project.

2. Set read/write rules to be global in Firebase.

Firebase dashboard console -> Database -> Rules

{
  "rules": {
    ".read": true,
    ".write": true
  }
}

3. Set up HTML container:

<div id="trollbox"></div>

4. Copy Firebase project config from dashboard and initialize trollbox:

const Trollbox = require('trollbox')

const config = {
  // DOM selector for trollbox
  container: '#trollbox',

  // Firebase project config found in dashboard
  firebase: {
    apiKey: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
    authDomain: 'xxxxxxxx-xxxxx.firebaseapp.com',
    databaseURL: 'https://xxxxxxxx-xxxxx.firebaseio.com',
    projectId: 'xxxxxxxx-xxxxx',
    storageBucket: 'xxxxxxxx-xxxxx.appspot.com',
    messagingSenderId: 'xxxxxxxxxxxx'
  },

  // trollbox channel name (chat room)
  channel: 'global',

  // trollbox username
  user: 'anon'
}

const trollbox = new Trollbox(config)

5. Copy base trollbox.css stylesheet into your web app.

6. That's it!

Later on if you need to, you can change the channel name and user:

trollbox.setChannel('random')
trollbox.setUser('Bob')

You can also completely destroy the trollbox:

trollbox.destroy()

License

MIT