Skip to content

Latest commit

 

History

History
44 lines (35 loc) · 3.11 KB

development.md

File metadata and controls

44 lines (35 loc) · 3.11 KB
Raw

LAREX: Development

LAREX is a web application written in Java. It uses Maven as building tool and is a Spring application.

Frameworks, tools and resources

  • Maven - Project builder and repository provider
  • Spring Framework - Base framework to create the Java web application
  • OpenPNP/OpenCV - "OpenCV Java bindings packaged with native libraries" for image processing
  • PRImA PAGE xml - Input and output format for segmentation and ground truth production data with the official library
  • Paper.js - "The Swiss Army Knife of Vector Graphics Scripting" used to draw the interactive viewer"
  • Materialize CSS - "A modern responsive front-end framework based on Material Design"
  • SASS - Enhanced style sheet language to create css from scss files (enhanced css)

Important notes for development from source

SASS

LAREX can be developed by changing the sources and updating the installation as it is described in Installation in the README. Only one difference should be noted. In order to edit the style of the application SASS is required to create css files. The base compiled versions of the current scss files can be found in the css directory. In order to edit the css one must make the changes in the scss files and compile them into the css folder as described in the official SASS guide

e.g. (inside the LAREX folder)

sass --watch scss:src/main/webapp/resources/css --style compressed

PRImA PAGE XML

The base format of LAREX is the PAGE xml from PRImA. While LAREX uses maven as building and dependency providing tool, PRImA does not provide the official base library for PAGE XML as a maven module. LAREX has therefore added the compiled PRImA jars into a local maven repository (src/lib). Updating the PRImA libraries therefore requires more changes than other maven dependencies in this project. One must update more than its version in the pom.xml. Adding new versions to the local repository can be done with a predefined script (sh add.sh). The script guides the developer through the installation in the local repository, by asking for the file, preferred maven group id, artifact id and version. Information should mirror the module information in pom.xml with a new version number.

Spring

Spring Framework is an application framework and hereby used to create a web application for a Tomcat Server.