GroIMP wiki

a part of grogra.de

User Tools

Site Tools

Trace:
You are here: GroIMP documentation » User tutorials » Installation » Install from source code
02_user_tutorials:01_installation:02_from_source

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
02_user_tutorials:01_installation:02_from_source [2025/12/10 13:14] – removed - external edit (Unknown date) 127.0.0.102_user_tutorials:01_installation:02_from_source [2025/12/10 15:33] (current) – gaetan
Line 1: Line 1:
 +~~NOTOC~~
 +====== Install from source code ======
  
 +GroIMP can be installed from the sources. The code is compiled and packaged to be runnable. This enable to have the lattest version on the code, which can be unstable.
 +
 +===== Requirements =====
 +
 +GroIMP 2.2.2 requires
 +the installation of a  Java runtime environment of version 21. This
 +can be obtained from Oracle at [[https://www.oracle.com/|www.oracle.com]].
 +
 +The compilation require Maven that can be found at the [[https://maven.apache.org/install.html|apache website]]. The minimum version required is 3.6, but it is recommended to use the latest version.
 +
 +Additionally, the default compilation will run a perl script. Thus, it requires to have perl installed. If it is not already installed (on Windows) it can be found at [[https://learn.perl.org/installing/windows.html|perl website]].
 +
 +===== Download =====
 +
 +The source can be found on [[https://gitlab.com/grogra/groimp/|gitlab]]. Notice that the main repository only contains the core of GroIMP. 
 +
 +==== Cloning the repository ====
 +=== From GitLab ===
 +
 +This method do not require any Gitlab account.
 +
 +It is possible to simply download the directory of source code from GitLab on the main page [[https://gitlab.com/grogra/groimp]]. There is a download arrow button right next to the _clone_ button. 
 +You can then download the whole repository as any archive format you like. 
 +Once it is downloaded, extract the archive to the directory in your workspace. 
 +
 +=== From a bash command ===
 +
 +You can clone a repository from GitLab with the command line: 
 +<code>
 +git clone  https://gitlab.com/grogra/groimp.git
 +</code>
 +
 +This will create a directory named groimp and download all the remote content in it.
 +
 +
 +===== Run the installation =====
 +
 +==== Compile with Maven ====
 +
 +Now that you have the source code on your local device, you can compile it with Maven. Maven require ''pom.xml'' files to process a project.
 +GroIMP core have both a parent pom.xml and a pom.xml for each plugins. Additional plugins only have their pom.xml. 
 +Maven commands are executed from a terminal (bash, Powershell, ...).
 +Maven commands can be executed either at the project level (on the parent ''pom.xml'') or at the plugin level (whithin a plugin, at a ''pom.xml'' level). The commands at the project level will propagate to all plugins defined within the parent pom file. 
 +
 +The plugins are added with the <module/> tag. You can add or remove plugins to the parent. The plugins are defined with their repository name. Make sure that all the plugins that you want to be included in the commands are listed there.
 +
 +The most useful maven commands are:
 +
 +  * ''mvn compile'' will compile the code under ''/groimpsourcepath/pluginpath/target/''. In the case where it is executed at the groimp root (for the groimp core), the compiled classes are stored under each plugin/target directory.
 +  * ''mvn package'' will compile the code, and package it for deployment. The compiled package is under ''/groimpsourcepath/app/''. It should automatically include dependency jars and resources. The packaged repository can be copied to an other groimp installation. 
 +  * ''mvn clean'' clean the repository, deleting all ''target'' and ''app'' repositories.
 +
 +If you package the groimp core code, you will have a ''platform-with-dependency.jar'' in the ''/groimpsourcepath/app'' directory. You can start the compiled version of GroIMP with
 +'' java -jar platform-with-dependency.jar''.
 +
 +==== Common errors ====
 +
 +The maven commands can fail, here are some common errors:
 +  * ''The goal you specified required a project to execute but there is no POM in this directory ... ''. This happens when you execute the maven commands in a directory without a proper pom file. You might not be in the correct directory, or the git clone commands may have failed. Make sure you have a pom.xml file in the current directory when executing a maven command
 +  * ''Child module /some/path/PLUGINNAME of ... /some/other/path/pom.xml does not exist @''. This happens when using the parent pom.xml. It means that one GroIMP plugin is defined in the <module> list of the plugins. However, that plugin is not found on the local directory. Make sure you remove all ''<module>'' elements from the parent pom.xml that are not present on your local installation.
 +  * ''Could not resolve dependencies for project xx.xx:version''. This happens when one plugin depends on a dependency that cannot be reached. Either the dependency is not released yet (it can happens with groimp plugins) or the maven repository requested is unavailable.