deborah

「deborah」は、以下の複数環境で動作する、オープンソースのチャットbotです。

• Slack
• Twitter
• LINE
• Web (HTML5/CSS3/Javascript)
• stdio（標準入出力）

必要環境

• Node.js
• npm（必要なグローバルモジュールは以下。これ以外の依存パッケージについては、npm installコマンドを実行すると、一括で入れることができる。）
  • typescript
  • forever
  • typedoc

開発者向け

# set up
sudo npm install -g typescript forever typedoc
npm install
# 場合によっては npm install --python=python2.7 のようにpython2系のパスを指定する

# 必要に応じてブランチを切る
git branch some_graceful_name

# 設定ファイルを作成(setting.jsonについてを参照)

# ... edit some code ...

# compile & run server on localhost
make run

settings.jsonについて

動作させる前に、設定ファイルとして、以下のようなsettings.jsonファイルを作成し、同ディレクトリ内に置いてください。

{
	"interfaces": [
		{
			"type": "stdio"
		},
		{
			"type": "webapi"
		}
	],
	"profile": {
		"name": "botname",
		"slack-icon": ":innocent:"
	},
	"lib": {
	},
	"responders":["DeborahResponderEcho"]
}

設定パラメータの意味

interfaces : any[]

• この配列中に、接続先各デバイスの情報を格納します
• type: "stdio"
  • 標準入出力。特別に設定すべきパラメータはありません
• type: "slack"
  • team : string
    • 対象となるチーム チーム名.slack.com
  • token : string
    • APIトークン（ https://api.slack.com/bot-users で取得できる）
    • トークン取得後は、クライアントのAppsよりボットを追加した上で、必要なチャンネルに招待すること。
  • output : boolean
    • このドライバを出力に使用するか否か（falseの場合、返答は送信されず標準出力に表示される）。
  • channels : string[]
    • botが活動できるチャンネル。これ以外のチャンネルでは発言できない。
• type: "twitter"
  • screen_name : string
    • botのTwitterIDの@を取ったもの michiru4s
  • consumer_key : string
  • consumer_secret : string
  • access_token_key : string
  • access_token_secret : string
    • APIトークン（いずれもhttps://apps.twitter.com/ で取得できる）
• type: "line"
  • accessToken : string
  • channelSecret : string
• type: "webapi"
  • Web用。特別に設定すべきパラメータはありません
  • 起動中、localhostのポート3000にブラウザからアクセスすると、Deborah Webの画面が表示される

profile : any

• name : string
  • 発言する際の名前
• slack-icon : string
  • slackで発言する際のアイコン（Slack上の絵文字の記法で書く）

lib

• vectorpath : string
  • word2vecで使う辞書のパスを指定する

起動方法

テスト用にforegroundで起動する場合

リポジトリ直下で下記コマンドを実行

node deborah.js

継続的にデーモン化して動作させる場合

まずforeverパッケージをnpmでグローバルにインストールする。

sudo npm install -g forever

起動コマンドは下記の通り。

forever start deborah.js

動作状況の確認コマンドは下記の通り。

forever list

停止コマンドは下記の通り。

forever stop deborah.js

このプロジェクトについて

Deborahは Tier IV, Inc. の支援を受けて開発されています。

License

MIT License