README

slack-users-webtask

Webtask.io service for a slack badge showing the current and total users of a slack team.

Install

Install with npm:

$ npm install --save slack-users-webtask

Usage

var users = require('slack-users-webtask');
module.exports = function(ctx, req, res) {
  // do any customization for your implementation here
  users(ctx, req, res);
};

What is this?

This module is intended to be used in a webtask.io task to create an svg badge showing the current online users for a slack community.

There is a distribution file provided in dist/main.js if you want to deploy it to webtask.io directly using the following command:

$ wt create node_modules/slack-users-webtask/dist/main.js --name my-slack-users-name --secret SLACK_TEAM='my-slack-team' --secret SLACK_TOKEN='XXXXXXX'

The main requirement is to provide the SLACK_TEAM and SLACK_TOKEN values. The above example shows setting them as secrets so they'll be available on the ctx when the webtask is executed.

The SLACK_TEAM property is the same as the subdomain used when accessing slack... https://{slack-team}.slack.com. The SLACK_TOKEN property is the authentication token of an administrator for the specified slack team that can users people to slack.

Webtask usage

After the webtask has been created, it can be used by doing a GET request from the webtask url.

$ curl https://webtask.it.auth0.com/api/run/wt-{my-profile}-0/my-slack-users-name?webtask_no_cache=1

An svg image will be returned with the current and total users for the specified slack community.

Acknowledgments

The slack badge template is based and size calculations are based on the badge provided in the slackin project.

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for avice on opening issues, pull requests, and coding standards.

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Brian Woodward

License

This file was generated by verb-generate-readme, v0.1.30, on August 29, 2016.

Usage no npm install needed!