Directory structure for JForum3

JForum3 uses a directory structure similar to the one used by Maven, although it is not the same. It also means that JForum does not use Maven for any particular task. Usually, Eclipse, IntelliJ IDEA and Netbeans users may want to simple use the build tool provided by the IDE itself, even that there is an ANT build file for those who want it.

A brief explanation about the main directory is below.

• src
  • Main directory for all Java and resource files, including test cases
• complile-lib
  • Libraries required for compilation, but not runtime
• doc
  • General documentation. May be third parties or JForum specific
• target
  • Target directory for Ant builds
• src/main/java
  • JForum3 source code core
• src/main/resources
  • General configuration files required by any library used by the core. Files in this directory are copied into WEB-INF/classes when compiling
• src/test/java
  • Test cases
• src/test/resources
  • Configuration files required by any library used in the test cases. Files in this directory are copied into target/tests when compiling

Output folders

Output folders are those directories where the .class files and other resource files are located, when compiling.

• webapp
  • Root directory for the web application
• webapp/images
  • General images used by the web application (smilies and other data common to all templates)
• webapp/templates
  • Templates root directory. In JForum, each custom template should be located inside this directory.
• webapp/templates/default
  • The default template of JForum
• webapp/WEB-INF
  • Application's WEB-INF directory
• webapp/WEB-INF/jforumConfig
  • Where all JForum configuration files are at.