Skip to content

Getting Started

Jump to bottom
rodrigodesalvobraz edited this page May 20, 2018 · 7 revisions

Getting Started

Getting started using the AIC-PRAiSE project (for developers)

Setting up your workspace

You can check out from the project's GitHub repository directly. For this you will require a Git client; see the following for useful instructions:

Using the Command Line and Maven

AIC-PRAiSE consists of a single Maven pom.xml file and can be built from the command line using Maven as follows:

mvn clean test

Using the Eclipse IDE

Prerequisites

Installing the m2e buildhelper connector

Note: This connector is required to properly set up resource paths for ANTLR generated parsers.

  • Select the menu item Window->Preferences...
  • Select the Maven->Discovery configuration option:

  • Click the Open Catalog button.
  • In the Install me2 connectors dialog, select the buildhelper connector (if it does not show up in the list, you may already have it installed; this can be checked in Eclipse's Help -> Installation Details):

  • Click the Finish button.
  • In the Install dialog, click the Next button:
  • Follow the sequence of Install Details, click Next button, Review License, click I accept terms of the license agreement, and click the Finish button.
  • A dialog will then pop up with a security warning stating that the software to be installed is unsigned. Click the OK button.
  • You will then be asked to restart Eclipse, click the Yes button.

Setup aic-expresso

Before setting up your aic-praise workspace you should first setup the AIC-Expresso workspace as aic-praise is dependent upon it.

Setup aic-praise workspace

Note: You will require a GitHub account, and a clean workspace, for these steps to work correctly.

  • Select the menu item File->Import...
  • In the Import Select dialog, select Git->Projects from Git:

  • Hit the Next > button.
  • In the Select Repository Source dialog select Clone URI:

  • Hit the Next > button.
  • In the Source Git Repository dialog enter the URI https://github.com/aic-sri-international/aic-praise.git for the project and your own GitHub User: name and Password::

  • Hit the Next > button.
  • In the Branch Selection dialog only select the master branch:

  • Hit the Next > button.
  • In the Local Destination dialog enter the Directory: where you would like your local copy of the AIC-Expresso Git repository to be placed:

  • Hit the Next > button.
  • In the Select a wizard to use for importing projects dialog, select the Import as general project option (Note: this dialog may take a while to enable as it will be downloading a copy of the repository to your local drive):
  • Hit the Next > button.
  • In the Import Projects dialog:

    Hit the Finish button.
  • This step is about turning your project into a Maven project (which is a project building tool). It may be unnecessary if you are using an Eclipse version whose Import dialog includes a Maven option and you selected that (or left it selected as a default). If not, select the project in the Eclipse Package Explorer and bring up the context sensitive menu (right click under Windows) and select Configure->Convert to Maven Project...:

  • Depending on your version of Eclipse, you might get warnings like "Access restriction: (...)" for JavaFX classes. These are due to an Eclipse bug (as of May 2018) that requires extra configuration. A simple solution is to install e(fx)clipse, which performs that extra configuration automatically. Another one is follow these instructions.
  • You should now be able to build and test the project from within Eclipse. Note: You may need to clean and build the project twice initially. This is because the main source is dependent on code being generated by the Antlr parser generator on the first compilation.

AIC-PRAiSE

Clone this wiki locally