GCube Project Layout

From Gcube Wiki
Revision as of 02:42, 26 July 2020 by Manuele.simi (Talk | contribs) (Project Layout Explained)

Jump to: navigation, search

Standard Project Layout

gCube projects for new software components are primarily developed with the Java language using Maven as build automation tool. The layout of a project mostly reflects the common conventions used for Maven with some variations.

- project folder/
  |
  |-src/
     |-main/
        |-java/
        |-webapp/
        |-resources/
     |-test/
        |-java/
        |-resources/
  |-gcube/
     |-extra-resources
        |-WEB-INF/
        |-META-INF/  
  |-pom.xml
  |-CHANGELOG.md
  |-LICENSE.md
  |-README.md
  |-FUNDING.md

Project Layout Explained

File or Directory Role
pom.xml an XML file that contains information about the project and configuration details used by Maven to build the project.
src/main/java/ application source code
src/main/webapp/ web application source code
src/main/resources/ resources packaged at root level in the output jar/war
src/test/java/ source code for tests
src/test/resources/ resources available on the test classpath
gcube/extra-resources/WEB-INF/ extra resources to add to the WEB-INF dir of the output jar/war. These resources are filtered
gcube/extra-resources/META-INF/ extra resources to add to the META-INF dir of the output jar/war. These resources are filtered