Getting Started

Prerequisite

You must have a JDK 1.8 or newer in order to compile (even if the 1.7 version should be supported recompiling the project with different options, I prefer to encourage users to move to the latest and greatest versions) Maven 3.2.1 minimum is used as a build tool. Npm and ruby must be installed to compile the UI module. Karaf 3.0.x as a runtime environment.

Installation

For UI module: Run these commands before doing anything: 
1
2
3
4
5

sudo npm -g install grunt-cli
sudo npm -g install phantomjs
sudo npm -g install bower
gem install sass
gem install compass
Also, you’ll need the selenium firefox Gecko Driver and Firefox web browser in order to run selenium tests, more info on the Selenium page ! Debian users: install node-legacy with apt to be able to compile the framework !
! Windows users: project pathes can be longer than windows can handle: take care to create your project in a workspace that is not too deep in the hierarchy !

IDE

Development has been tested on an Eclipse platform (but can be supported by others IDE) with the following plugins:
  • Lombok (Mandatory): helpers for coding with far less LOC.
  • M2E: Maven support for eclipse (NOT mandatory, only Maven is required).
  • Egit: for source control (you can also use any other source control technology).

Other useful plugins

QuickStart

In eclipse go to new->Maven project and choose one of the net.osgiliath.archetype you want to work with (a parent first, then submodules…). archetype on the archetype selection (take care of the ‘include snapshot’ checkbox if you want to use Osgiliath SNAPSHOT archetypes). To compile your project, right click on it->Run As-> Maven install. For UI module: You can use grunt at the root of your ui module instead of maven to interact within the build chain: grunt test: executes unit tests grunt serve: runs a server for your ui with livereload enabled grunt build: same as running mvn clean install on the same module.

Comments