GroIMP wiki

a part of grogra.de

User Tools

Site Tools

Trace:
dev-guide:getting-started

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
dev-guide:getting-started [2024/06/25 12:01] – [Maven] gaetandev-guide:getting-started [2024/12/18 10:54] (current) – [Developer Guide] gaetan
Line 5: Line 5:
 Developing on the GroIMP source code only require a java compiler. Additionally GroIMP support two development setup: Maven and Eclipse. Developing on the GroIMP source code only require a java compiler. Additionally GroIMP support two development setup: Maven and Eclipse.
  
 +==== Requirements ====
 +
 +To compile GroIMP you will need the following additional tools:
 +  * [[https://maven.apache.org/install.html|Maven]]
 +  * [[https://www.oracle.com/java/technologies/downloads/|Java 17]] or newer
 +  * [[https://www.perl.org/get.html|Perl]]
 ===== Get the source code ===== ===== Get the source code =====
  
 The first step to start developing on the code is to get it. The code is entirely open source and available on [[https://gitlab.com/grogra/]].  The first step to start developing on the code is to get it. The code is entirely open source and available on [[https://gitlab.com/grogra/]]. 
  
-The source code is split between the "core" at [[https://gitlab.com/grogra/groimp]] and the plugins at  [[https://gitlab.com/grogra/groimp-plugin]]. It is possible to work separately on the core and the plugins as each are compilable by themselves.+The source code is split between the "core" at [[https://gitlab.com/grogra/groimp]] and the plugins at  [[https://gitlab.com/grogra/groimp-plugins]]. It is possible to work separately on the core and the plugins as each are compilable by themselves.
  
  
 ==== (Optional) Forking the repository ==== ==== (Optional) Forking the repository ====
  
-  * Ordered List ItemGo to the git repository page in your internet browser.+  * Go to the git repository page in your internet browser.
   * Click on the //Fork// button of the repository.   * Click on the //Fork// button of the repository.
   * Select your own gitlab namespace and optionally an other project name (not recommended).   * Select your own gitlab namespace and optionally an other project name (not recommended).
Line 53: Line 59:
 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. 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.  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, ...), and they are executed at the root of the ''pom.xml'' considered. I.e. for the groimp core at the parent repository, for an individual plugin in its repository.+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: The most useful maven commands are:
Line 63: Line 72:
 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 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''. '' 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.
 +
 ===== Eclipse ===== ===== Eclipse =====
  
 See the guide on how to setup your Eclipse environment [[:dev-guide:developer-guide| here]]. See the guide on how to setup your Eclipse environment [[:dev-guide:developer-guide| here]].
dev-guide/getting-started.1719309681.txt.gz · Last modified: 2024/06/25 12:01 by gaetan