Skip to content

Latest commit

 

History

History
86 lines (54 loc) · 4.15 KB

README.md

File metadata and controls

86 lines (54 loc) · 4.15 KB
Raw

About

A simple tool to calculate the overall performance of an investment portfolio.

See https://www.portfolio-performance.info for more details.

Build Status Latest Release Release Date License

LOC Bugs Vulnerabilities Code Coverage

Prerequisites

Developing with Eclipse

Eclipse Setup

To develop, use the latest Eclipse IDE release plus Plug-in Development Environment (PDE). PDE homepage is https://www.eclipse.org/pde/ and it can be installed via Help/Install new Software. The link for the update site is mentioned in the PDE docs.

Optionally, install via the Eclipse Marketplace

  • infinitest
  • ResourceBundle Editor
  • SonarLint
  • Eclipse Checkstyle Plug-in

Setup

Clone the git repository by cmd or by download also.

Import projects by

  • selecting "Import Projects..." on the Git repository in the Git perspective
  • choosing "File" > "Import..." > "Existing Projects into Workspace" from the menu

After importing the Portfolio Performance projects in Eclipse, they will not compile due to missing dependencies: the target platform is missing.

Set Target Platform

  • Open the portfolio-target-definition project
  • Open the portfolio-target-definition.target file with the Target Editor (this may take a while as it requires Internet access). If you just get an XML file, use right click and chose Open With Target Editor
  • In the resulting editor, click on the "Set as Active Target Platform" link at the top right (this may also take a while)

Run Program

Run the application and the tests with the launch configurations stored in ./portfolio-app/eclipse folder (right-click "Run As").

⚠️ The launch configuration needs an update when bundles are added and removed or the OS platform changes. If the program does not start, try selecting "Add required plug-ins" in the launch configuration dialog.

Building with Maven

Maven is not required (anymore) to develop Portfolio Performance as you can develop using the Eclipse IDE with the setup above. The Maven build is used for the Github Actions build.

The Maven build works fine when JAVA_HOME points to an (Open-)JDK 11 installation.

Configure

Mac OS X / Linux

export MAVEN_OPTS="-Xmx1g"

Windows

set MAVEN_OPTS="-Xmx1g"

Build

Run Maven 3.x.x:

mvn -f portfolio-app/pom.xml clean verify

Note, under Windows the maven-enforcer plugin (used in ./portfolio-app/pom.xml) has an issue with ${project.basedir}, so you need skip it like

mvn -f portfolio-app\pom.xml -Denforcer.skip=true clean verify

License

Eclipse Public License https://www.eclipse.org/legal/epl-v10.html