tavle

Tavle

A tiny chat server for classroom.

概要 Description

It is an example implementation of online chat system using WebSocket. tavle is a blackboard in Norwegian.

Websocket を使ったチャットの実装例です。 このプロジェクトは、コミュニティ eLV の活動を通じて生まれました。

とりあえず動かしてみたい方は How to Use をご覧ください。

必要なもの Requirement

サーバの実行は、Windows、Mac、Linux 上で動きます。 クライアントはウェブブラウザ (Chrome、Safari、Firefoxなど) で接続します。

使い方 Usage

設定ファイルを配置し、実行します。 詳しくは How to Use をご覧ください。

インストール方法 Install

ビルド済みのバイナリを入手し、展開してください。 ビルドする場合は、次の節も参考にしてください。

with Docker

$ docker pull ryumei/tavle
$ docker run -p 18080:8000 ryumei/tavle

開発者向け情報 How to Build

開発作業確認済み環境情報

• Go (v1.9)
• glide (v0.12.3)

利用している OSS / Working with OSS

• gorilla/websocket for server side
• Vue.js for client
• Materialize for client side

ビルド方法

$ make

クロスコンパイル

$ make dist

Troubleshooting: golint not found

golint をインストールしてください。

$ go get -u github.com/golang/lint/golint

Contribution

1. Fork
2. Create a feature branch
3. Commit your changes
4. Rebase your local changes against the master branch
5. Run test suite with the go test ./... command and confirm that it passes
6. Run gofmt -s
7. Create new Pull Request

ライセンス License

Apache License Version 2.0

Author

Takaaki NAKAJIMA