Knowledge

デモ

• 実際にどう動くかをデモで確認する事ができます

  Live Demo

デモ用のユーザ

• [id/password] user1 / user1
• [id/password] user2 / user2
• [id/password] user3 / user3

Dockerを使った簡単環境構築

• Knowledgeの環境をDockerで作成するDockerfileを置いています

  Get Dockerfile

インストール

• Java version 8 以降をインストール
• Tomcat 8.0 以降をインストール (http://tomcat.apache.org/)
• Tomcat でなくても、Servlet3.1 以降に対応しているサーバーであれば動作すると思います
• Tomcat のインストールのパスには空白が入らないようにしてください
• knowledge.war をダウンロード
• Tomcatのwebappsディレクトリに、knowledge.warを置く(warが配備され使えるようになります)

初期設定[管理者ユーザの登録]

• http://[tomcatサーバーのIP]:[tomcatサーバーのポート]/knowledge にアクセスします
• Tomcatを自分のPCにインストールした場合、「http://localhost:8080/knowledge」にアクセスします
• インストールしたknowledgeのシステムのトップページが表示されます
• 右上の「sign in」を押してください
• [id/password] admin / admin123 でサインインしてください（セットアップ用管理者ユーザ）
• 右上のメニューに管理者メニュー「config」→「users」が表示されますので、新しい管理者ユーザを追加してください
• 右上の「sign out」を押下し、セットアップ用管理者ユーザをサインアウトします
• 登録した新しい管理者でサインインし、再度「config」→「users」でユーザの管理画面を開きます
• セットアップ用管理者ユーザを削除します

利用者の追加方法

• ユーザの追加は以下の３つの方法から選択します
• 1. 管理者がユーザ管理する → 管理者がユーザ登録します
• 2. ユーザ自身が登録（登録されたメールアドレスにメールが届くかチェックします）
• 3. ユーザ自身が登録（チェック無し）

データのバックアップ

• Tomcatの起動ユーザの、ホームディレクトリに「.knowledge」というフォルダを作成し、その中にデータを格納します
• データのバックアップは、このディレクトリをコピーしておくことで可能です
• Linuxなどでは、Tomcat起動ユーザで上記のディレクトリにアクセス出来るように、権限を設定してください

EclipseとTomcatを使った開発方法を説明します。

"Eclipse IDE for Java EE Developers"をダウンロードすれば、
以下のステップで開発やデバッグが出来ます。

• Eclipseをダウンロード
• Githubからソースをクローン
• Eclipseを起動 (JRE1.8 を使ってください) JavaEE Parspective が表示されます
• Eclipseで「File > Import > Maven > Existing Maven Projects」を選択し 「Knowledge」のディレクトリを選択し finish を押します

EclipseへのImportが完了しました。

Eclipseを使って実行するには、もう少し操作を行います。

• Tomcat v8 をダウンロードします(Websocketなど最新機能を使うので最新のもの）
• Eclipse の下部に "Servers" のビューがあるので表示します
• "No servers are avaliable. Click this ....." と書かれているのでクリックします
• ウィザードに従い、Tomcat v8のサーバーをEclipseにセットアップします
• Eclipse の "Servers" のビューにTomcatのサーバーが表示されます（Stoppedになっています）
• Tomcat Server を右クリックし、"Add and Remove" のコンテキストメニューを選択します
• 上のステップでEclipseにインポートした"Knowledge"をTomcat Serverへ追加(Add)します
• Tomcat Server を右クリックし、 "Start" のコンテキストメニューを選択します

ローカルのTomcatで"Knowledge"が起動しました。
"http://localhost:8080/knowledge" でアクセスする事ができます！

最後に、フロントエンドのライブラリを取得します。

サーバーサイドのライブラリはMavenで行っていますが、フロントエンドのライブラリの管理にはBowerを使っています。

（Mavenの方は、EclipseにMavenプロジェクトをインポートした時点で、Javaの依存ライブラリを取得します）

BowerはNode.js製のツールなので、Bowerをインストールするためには、Node.jsが必要になります。

• Node.js(https://nodejs.org/)をインストールします
• Bower(http://bower.io/)をインストールします
• Bowerのインストールは上記のサイトに書いてありますが、Node.jsをインストールした上で、コマンドラインで「npm install -g bower」を実行します
• フロントエンドのライブラリを取得するため、Knowledgeのソースディレクトリにて、「bower install」を実行します

開発する準備が整いました

開発したら、マージリクエスト送ってくださいね！

さらに詳しい開発手順の説明を以下に掲載しています。

>> How to Develop the Knowledge <<

ご自身で変更した内容でwarを作成する方法を説明します。

KnowledgeのビルドはMavenにて実施します。

まずは、ローカルにMavenをインストールしてください。（Mavenのインストールは別途お調べください）

Mavenのインストールが完了していれば、「mvn -version」のコマンドで情報が出力されるようになります。

Knowledgeのディレクトリに移動し、以下のコマンドを実行してください。

• mvn clean
• mvn compile
• mvn war:war

Knowledgeのディレクトリの中の「target」の中に、knowledge.warが作成されます

Knowledgeでは多言語対応に対応できる仕組みを用意しています。

ここでは、ローカライズ方法について説明します。

※「どうせ公開するならグローバルに！」と思い多言語対応しましたが、英語メッセージが非常に変になっています（ほとんどGoogle翻訳です）

というわけで、英語のメッセージを修正してくれる方いましたら、ぜひお願いします！

• 言語毎の文字列は、「/knowledge/src/main/resources/appresource_XX.properties」のファイルに定義しています。
• 新たな言語に対応する場合、既存の言語ファイルをコピーして作成するのが良いと思います。
• 例えばフランス語に対応する場合、「appresource_en.properties」をコピーし、「appresource_fr.properties」を作成して、文字列の部分をフランス語に変更します
• その後、メニューに追加した言語を追記します。
• /knowledge/src/main/resources/appconfig.xml の設定ファイルのLanguageの部分に対応した言語を追加します。

さらに詳しいローカライズの説明を以下に掲載しています。

>> Localization 'Knowledge' <<

Developer's Social Site

       

Send Message

Submit