Skip to content

pacdiv/embedded-slack

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

embedded-slack

embedded-slack allows you to add a Slack built-in chat on your website. This chat can be connected to your support team.

Note: ⚠️ embedded-slack has been developed as a technical try to determine if Slack can be used from a web page, to allow customers to discuss with a support team. It currently works with a test token so, at this time, using this package in production is not recommanded.

Prerequisites


First, you'll need to generate a test token for your Slack team. Then, you need'll to pick one channel ID from your Slack team. If you don't have any channel ID, feel free to copy/paste and run the following code to get one:

// channels.js
const slack = require('slack')
const token = "your_test_token"

slack.channels.list({ token }, (err, data) => {
  if (err) {
    console.error(err)
    return
  }
  console.log(data)
})
$ npm install slack
$ node channels.js

Installation and setting up with webpack 2.x


First, install embedded-slack and loaders using npm:

$ npm install --save embedded-slack
$ npm install --save-dev node-sass style-loader css-loader sass-loader

Then, add the following loader (lines 3 to 6) to your webpack module loaders:

module: {
  loaders: [
    {
      test: /\.scss$/,
      loaders: [ 'style-loader', 'css-loader', 'sass-loader' ]
    }
  ]
}

Usage


In this example, we create an EmbeddedSlack object with the three mandatory properties:

// index.js
import EmbeddedSlack from 'embedded-slack'

const chat = new EmbeddedSlack({
  containerId: 'embedded-slack',
  channel: 'your_channel_id',
  token: 'your_token'
})
<!-- index.html -->
<body>
  <div id="embedded-slack" />
</body>

By including those lines to your code, if prerequisites and installation are setted, a blue div will appear at the bottom right of your webpage. When you will write a message in this channel from your favorite Slack client, this message will appear in the chat you've just setted; feel free to respond ! 🙂

Built With


Slack - Slack Web and RTM API client for Node and the Browser

License


MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published