Portlet Build Project

Table of Contents

• Install the prerequisites
  • Install Node.js project dependencies:
• Checkout, Build, and Deploy
  • Checkout
    • Build project
    • Add auto deploy
• Configure Webservice

ℹ️	Before starting, please make sure you already set up the general KnowledgeFinder requirements: KnowledgeFinder- Prerequisites Also this portlet requires a instance of KnowledgeFinder - Webservice running on the same machine.

Install the prerequisites

To be able to test the frontend javascript code and compile LESS to CSS, you need to install modules and run commands via node.js and npm. This can be done with:

• Eclipse extension:
  

  • Spring IDE from http://dist.springsource.com/release/TOOLS/update/e4.3/ (you only need to install the components containing the phrase "Spring IDE")

• Standart node.js installation:

  • Download and Install Node.js (https://nodejs.org/en/) or via package manager

Install Node.js project dependencies:

To install all necessary modules needed in this project invoke the command npm install on the file package.json, located in knowledgefinder-webapp/portlet. The modules used for testing and compiling the styles can be found in the coresponding documentations.

Checkout, Build, and Deploy

Checkout

If not already done clone the repository at https://github.com/KnowledgeFinder/knowledgefinder-webapp

To build the project another settings configuration project is needed. For a list see KnowledgeFinder - Instances. Here the example configuration project is used.

Build project

Make sure the the modul portlet is used:

knowledgefinder-webservice/pom.xml

...
<modules>
    ...
    <module>portlet</module>
    <module>${knowledgefinderII.path.prefix}knowledgefinder-config-${knowledgefinderII.instance.name}/portlet-config</module>
</modules>
</modules>
...

otherwise see Webservice - Get Started to build the portlet together with the webservice.

Add auto deploy

See Webservice - Get Started to build the portlet together with the webservice.

Configure Webservice

This portlet requires a instance of knowledgefinder-webservice running on the same machine or the server have to set headers needed for http://www.w3.org/TR/XMLHttpRequest/ Cross-origin resource sharing. 

The connection to the webservice is defiend in src/main/resources/server.properties in the configuration project. For further information see the example configuration project.