Portlet Build Project

ℹ️	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.

ℹ️	To build the project, another configuration project is needed, e.g. the KnowledgeFinder example configuration. In the following the example configuration project is used to illustrate the set up. A list of configuration projects can be found at KnowledgeFinder - Instances.

Table of Contents

• Install the prerequisites
  • Spring IDE
  • Node.js
    • Install Node.js project dependencies:
• Clone
• Build
  • Activate Portlet
  • Configurations

Install the prerequisites

Spring IDE

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

Node.js

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.

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.

Clone

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

You also need the knowledgefinder-core project: https://github.com/KnowledgeFinder/knowledgefinder-core.git

Build

Activate Portlet

Make sure the the modul portlet is used:

knowledgefinder-webapp/pom.xml

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

Configurations

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.

Otherwise see Webservice - Build Project to build the portlet together with the webservice.