quoridorn-server

Application server of the Quoridorn.

クライアント：quoridorn-mark2(GitHub)

Quoridornとは？

• 公式サイト
  
• 制作者：HillTop(Twitter)

構成物

• Node.js
• socket.io
• nekostore
• MongoDB

スペシャルサンクス

• nekostore
  • 制作者：https://github.com/esnya
  • Repository：https://github.com/esnya/nekostore

使い方

使えるようにしておくべきコマンド

• git
• npm
• node
• mongo
• mongod

1. Quoridornサーバ本体の配置

   1. git clone https://github.com/HillTopTRPG/quoridorn-server.git GitHubからソースをダウンロード
   2. cd quoridorn-server 生成された「quoridorn-server」ディレクトリに移動
   3. npm install ライブラリをインストール
   4. （はじめての設置の際に）.env.exampleファイルを同じ場所に.envというファイル名で複製 (Ver.1.0.0a50～)
   5. （はじめての設置の際に）configフォルダの中のファイル名の末尾が.exampleとなっている3つのファイルも上記と同様に、元のファイルと同じ場所に末尾の.exampleを除いたファイル名で複製 (Ver.1.0.0a50～)
   6. （はじめての設置の際に）messageフォルダの中のファイル名の末尾が.exampleとなっている2つのファイルも上記と同様に、元のファイルと同じ場所に末尾の.exampleを除いたファイル名で複製 (Ver.1.0.0a50～)
   7. npm run build TypeScriptをビルドすることで「dist」フォルダにJavaScriptファイルが生成される

2. MongoDBを起動 ※ MongoDBの構築は詳しくは解説しません。（できません）

   1. mongo
   2. 「connection to: mongodb://127.0.0.1:27017/~~~~~~」 と表示されたらOK
      「mongodb://」からポート番号までの文字（例：mongodb://127.0.0.1:27017）をメモしておく
   3. エラーだったら構築に失敗してます。構築頑張って…🐧🌟

3. Quoridornサーバの設定を編集

   1. 「quoridorn-server/conf/server.yaml」を編集する（テキストエディタで編集可能）
      サーバ稼働に関する設定ファイル
      書き方や注意点はyamlファイル内にコメントを書いてあるので、それを見ながら頑張って設定値を書いてください
      前項でメモしておいたMongoDBの接続文字列はこのファイルに設定する
      バージョンアップに伴って項目が増える可能性もあるので、バージョンアップの際は注意してください。
   2. 「quoridorn-server/conf/storage.yaml」を編集する（テキストエディタで編集可能）
      ストレージサービスとの連携に関する設定ファイル
      書き方や注意点はyamlファイル内にコメントを書いてあるので、それを見ながら頑張って設定値を書いてください バージョンアップに伴って項目が増える可能性もあるので、バージョンアップの際は注意してください。
   3. 「quoridorn-server/message/message.yaml」を編集する（テキストエディタで編集可能）
      クライアントに表示されるサーバ情報の設定ファイル バージョンアップに伴って項目が増える可能性もあるので、バージョンアップの際は注意してください。
   4. 「quoridorn-server/message/termsOfUse.txt」を編集する（テキストエディタで編集可能）
      サーバ側の利用規約の文章をここに書いてください

4. Quoridornサーバを起動

   1. npm run node-server Node.jsサーバを起動
   2. 「Quoridorn Server is Ready.」と表示されたら構築完了🐧🎊
   3. (追記:Ver.1.0.0a49) 起動時にs3サーバーへの疎通を確認するようになりました。
      起動後に「S3 Storage upload-test success.」と表示されたらs3サーバーの構築確認ができます。