back channeling

バックチャネリング

バックチャネリングはリアルタイムBBSツールです。

次のような機能があります：

• 簡単にセットアップできます
• マークダウン形式をサポートします
• 音声チャットをサポートします
• コメントのキュレーション

始めましょう

オンプレミス

Datomic Tranactorを起動します。

 % bin/transactor

バックチャネリングを開始します。

 % DATOMIC_URL=datomic:free://localhost:4334/bc bin/back_channeling

デフォルトのポートは3009です。

ヘロク

または

1. gitクローン。

 % git clone https://github.com/kawasima/back-channeling.git

1. Herokuアプリケーションを作成します。

 % cd back-channeling
% heroku create

1. バックチャンネルを展開します。

 % git push heroku master

わずか3分かかります!!

API

サインアップするときは、ボットアカウントの種類を選択します。承認コードを覚えておく必要があります。

まず、認証コードによってトークンを取得します。

 POST /api/token

code=[authorization code]

次のように応答が得られます。

 {"access_token": , "name": "bot", "email": "[email protected]"}

BackChanneling Web APIをリクエストするときは、トークンをHTTPヘッダーに追加する必要があります。

 curl  -H 'Accept: application/json' -H 'Authorization: Token xxxxxxxxxxxxxxxx' [API url]

また、POSTリクエストを送信する場合は、リクエストヘッダーにContent-Typeを追加します。

 curl -X POST -H 'Accept: application/json' -H 'Content-Type: application/json' -H 'Authorization:  Token xxxxxxxxxxxxxxxx' [API url]

ボード

ボードデータを取得します。

 GET /api/board/:board-name

次のような応答の例：

 {
  "id":17592186045424,
  "name":"default",
  "description":"Default board",
  "threads":[
    {"id":17592186045428,
     "title":"aaa",
     "since":"20150722T101724.515Z",
     "last-updated":"20150722T110108.015Z",
     "resnum":1000,"watchers":[]},
    {"id":17592186045651,"title":"hohoho",
     "since":"20150722T104559.129Z",
     "last-updated":"20150929T123754.988Z",
     "watchers":["bot2"],"resnum":1000}
  ]
}

糸

 GET /api/thread/:thread-id

新しいスレッド

 POST /api/board/:board-name/threads

{"thread/name": "New thread", "comment/content": "Hello"}

コメントを投稿します

 POST /api/thread/:thread-id/comments

{"comment/content": "Hello"}