Differences

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

--- 05_developer_tutorials:01_setup:getting-started [2025/01/31 15:32] – removed - external edit (Unknown date) 127.0.0.1
+++ 05_developer_tutorials:01_setup:getting-started [2025/01/31 15:32] (current) – ↷ Page moved from 04_developer_documentation:dev-guide:getting-started to 05_developer_tutorials:01_setup:getting-started tim2
@@ Line 1: / Line 1: @@
+====== Developer Guide ======
+Welcome to this developer guide!
+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 =====
+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-plugins]]. It is possible to work separately on the core and the plugins as each are compilable by themselves.
+==== (Optional) Forking the repository ====
+  * Go to the git repository page in your internet browser.
+  * Click on the //Fork// button of the repository.
+  * Select your own gitlab namespace and optionally an other project name (not recommended).
+  * Change or reuse the project slug and description.
+  * Click on //Fork project//.
+==== (Optional) Mirroring the repository ====
+  * In an internet browser, go to your own repository that forks the official one.
+  * On the side bar, click on //Settings// > //Repository//.
+  * Expand the category `Mirroring repositories`.
+  * Insert the URL of the official repository: [[https://gitlab.com/grogra/groimp]] (or the url of the plugin)
+  * Click on //Mirror repository//
+**Note: the two previous steps are optional for users, but highly recommended if you plan on contributing to the code.**
+==== 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.
+===== 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.
+===== Eclipse =====
+See the guide on how to setup your Eclipse environment [[05_developer_tutorials:01_setup:developer-guide| here]].