Sample Application

Getting Started

To get started you need to clone both the oasp4j and oasp4js repositories containing the server and the client part respectively. Each of them is to be built and started to talk to each other it. There are two ways to get the sample application working: eithter by getting the oasp IDE and running it from there or setting up the IDE manually.

Full oasp IDE installation

If you want to install full OASP IDE and get both server and client code please follow steps described in oasp IDE setup. The oasp IDE already contains software (Node.js, Gulp, Bower, Maven) required to run the sample application; only Git has to be additionally installed.

Getting oasp4js client working

Install prerequisites

If the oasp IDE setup is not used, additional software has to be installed manually. You need a Git client to clone the repositories and the Node.js platform (including its package manager - npm) which allows Gulp and Bower to install the dependencies and build the application. Here you can learn how to install the prerequisites. Also, for the server part you need Maven (tested against the version: 3.3.9) to be installed. For installation details please refer to the Maven home page.

Please note that this client version was tested with following versions of the additional software:

• node.js version 5.0.0

• npm version 3.3.6

• gulp version 3.9.1

• bower version 1.7.7

Create the <oasp_dir> directory for the sample application

mkdir <oasp_dir>
cd <oasp_dir>

Set up the server part of the application

Clone the oasp4j repository:

git clone --recursive https://github.com/oasp/oasp4j.git -b master

Let Maven build the server part:

cd oasp4j
mvn clean install

After a successful build go to the following directory

cd samples\core\target

Configure the port number which should be used by the embedded tomcat server and its context path. To do this, create a new application.properties file in the <oasp_dir>\oasp4j\samples\core\target directory and add the following entries:

server.port=8081
server.context-path=/oasp4j-sample-server

Start the oasp4j-samples-core project as a Spring Boot application by running the following command in your console:

java -jar oasp4j-sample-core-dev-SNAPSHOT.jar

Set up the client part of the application

We asume you are back in the <oasp_dir> directory.

Clone the oasp4js repository:

git clone https://github.com/oasp/oasp4js.git -b master

Install the client part’s dependencies:

cd oasp4js
npm install

During the npm install process Bower downloads some libraries and uses Git for it. Git defaults to the Git protocol whose standard port (9418) is sometimes blocked by firewalls. A solution for this problem is to configure Git to use the https instead of the git protocol with following command:

git config --global url."https://".insteadOf git://

and to rerun the npm install command.

Start the application using Gulp:

gulp serve

The above Gulp’s task opens the client part of the application in your default browser and watches for any changes in HTML/JavaScript/CSS files. Once you change one, the page is reloaded automatically!

You can sign in using the following credentials: waiter/waiter or cook/cook.

If for some reason your client should talk to the server configured in a different way, you can configure the server details in the client’s configuration file, <oasp_dir>\oasp4js\config.json, in the proxy part:

{
    "proxy": {
        "baseUrl": "http://localhost:8081",
        "context": "/oasp4j-sample-server"
    }
}