Difference between revisions of "GCube Project Layout"

From Gcube Wiki
Jump to: navigation, search
(Created page with " = 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 pr...")
 
Line 9: Line 9:
 
     |-main/
 
     |-main/
 
         |-java/
 
         |-java/
 +
        |-webapp/
 
         |-resources/
 
         |-resources/
 
     |-test/
 
     |-test/
Line 31: Line 32:
 
|-
 
|-
 
| pom.xml
 
| pom.xml
| The fundamental unit of work in Maven. It is an XML file that contains information about the project and configuration details used by Maven to build the project.
+
| an XML file that contains information about the project and configuration details used by Maven to build the project.
 
|-
 
|-
| src
+
| src/main/java
| ...
+
| application source code
 +
|-
 +
| src/main/webapp
 +
| web application source code
 +
|-
 +
| src/main/resources
 +
| resources packaged in the output jar/war
 +
|-
 +
| src/test/java
 +
| source code for tests
 +
|-
 +
| src/test/resources
 +
| resources available on the test classpath
 
|}
 
|}

Revision as of 02:36, 26 July 2020

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

Dir or File 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 in the output jar/war
src/test/java source code for tests
src/test/resources resources available on the test classpath