DevelopmentEnvironmentConfiguration

Development environment configuration

This page describes all steps necessary to start developing ProSym

• Development environment configuration
  • Requirements
  • Getting source code
  • Maven configuration
  • Compilation
  • Database configuration
  • Deployment
  • NetBeans IDE

Requirements

All current development work was done using Debian 6 linux distribution, but it is possible to develop ProSym on other systems like Microsoft Windows or MacOS.

Software required to develop ProSym:

• Java SE JDK 6 update 30 or higher
• Apache Maven2
• Apache Tomcat 6
• PostgreSQL 8.4
• Mercurial client

Additional useful software:

• NetBeans IDE 7.1 or higher
• SUMO 0.15

Please read software documentation for installation instructions.

Getting source code

To get newest version of ProSym source code, clone mercurial repository using following command:

hg clone ssh://bikolek@hg.code.sf.net/p/prosym/code prosym-code

Maven configuration

ProSym uses Maven2 to build whole application. Maven manages things such as ProSym dependencies and libraries or build script. Unfortunately not all dependencies are available from online Maven repositories so some additional configuration is necessary to build ProSym.

Obtain jFuzzyLogic jar (version 2.1a) from project website http://jfuzzylogic.sourceforge.net. Then install it in local maven repository by typing following command:

mvn install:install-file -DartifactId=jFuzzyLogic -DgroupId=jFuzzyLogic -Dversion=2.1a -Dfile=PATH_TO_DOWNLOADED_JAR

Compilation

Now you should be able to build ProSym. Type following command

mvn install

in prosym-code directory.

Database configuration

ProSym uses PosrgreSQL. You need to create database and tables in it. For more information refer to PostgreSQL user documentation. Script with necessary table layout is available as attachment.

Deployment

Now you can edit config.properties file located in war's WEB-INF directory. Sample file contains description and example values for all fields. Do not commit this file unless you are adding new field

Now you may deploy your application to Apache Tomcat server.

NetBeans IDE

To facilitate development it is highly recommended to use IDE. Whole project was created using NetBeans IDE 7.1. This section contains useful hints while developing ProSym using NetBeans.

1. Register your Tomcat instance in NetBeans services, so it can automatically deploy ProSym whatever you modify code.
2. Remember to exclude config.properties from each commit you made.
3. Install NetBeans plugins for js, jsp, and j2ee.