Giter Club home page Giter Club logo

sharel's Introduction

Sharel

SharelはSlack上に作ったTwitterのようなコミュニケーションツールです。 WEB+DB PRESS 101号のSlack特集の解説のため主要機能に絞って実装しています。
(※実際のSharelはGitHubで公開していません)

概要

SharelはBot開発フレームワークであるBotkitをベースに作られたSlack Appです。 Sharelに対するダイレクトメッセージをフォロワーに転送することができます。 また、Slash Commandsでメニューを表示し、登録・退会・フォロー設定等を行います。

sharel

動作環境

  • Node.js(v6.3.0以上)
  • npm
  • ngrok

インストール方法

Slack AppとしてSharelの動作確認を行うための必要最低限の手順です。

ngrokをインストールして起動

SharelはSlackから一部のイベントを取得するためSSL/TLS対応のサーバを利用しています。 SSL/TLS対応のサーバ構築の手順を簡略化するためngrokを利用します。

# ngrokのzipをhttps://ngrok.com/downloadよりダウンロードして解凍
$ unzip /path/to/ngrok.zip
・・・
$ ngrok http 3000

Slack AppにSharelを登録

Slack Appを作成し以下の機能をSlack App登録画面から設定します。

  • メニュー表示するための「Slash Commands」
  • ボタン付きメッセージを利用するための「Interactive Messages」
  • RTM APIの利用とBotとのDirect Messageを利用するための「Bot Users」

Sharelのソースコードを取得

git clone [email protected]:hakamata-rui/sharel.git

必要モジュールのインストール

npm install

Sharelの起動及びチームへのインストール

Botkitを起動してhttps://${ngrokで割り当てられたドメイン}/loginからSharelをチームにインストールします。

PORT=3000 CLIENT_ID=xxxxx CLIENT_SECRET=xxxxx node index.js

Contribution

masterブランチのソースコードは大幅に変更することができないためバグ修正のみ受け付けます。
Sharelに新機能や機能改善を行っていただける場合はdevelopブランチにお願いします。

Licence

MIT

Author

hakamata-rui

sharel's People

Contributors

hakamata-rui avatar

Watchers

James Cloos avatar

Forkers

kawasaki2013

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.