瀏覽代碼

Added file explaining the directory structure of this project.

Thomas Flucke 7 年之前
父節點
當前提交
c330a302dd
共有 1 個文件被更改,包括 22 次插入0 次删除
  1. 22 0
      dir.md

+ 22 - 0
dir.md

@@ -0,0 +1,22 @@
+# Mapping of directory structure
+## Temporary directories marks with (t)
+* / - Contains all files relevant to project
+  * build (t) - Where compiled files/outputs are placed
+  * conf - Contains all configuration files
+    * dev - Configuration files for development
+      * ant - Files that will be loaded into ant to set properties.
+        * *.properties - Properties dynamically set in ant, prefixed with file name.
+      * app - Files that will be included in the final classpath to be loaded at run time.
+    * prod - Configuration files for production
+      * Same as /conf/dev
+  * lib (t) - Contains dependencies dynamically loaded by ivy
+    * Each sub directory represents the dependencies for a build target.
+  * src - Java files go here.  Mostly server code
+  * tests - Testing files go here
+    * Mirrors /src except contains tests for each java file
+  * web - User interface files go here.
+    * views - Directory of web pages the user can see
+    * js - Directory of javascript files
+      * templates - Any html files imported in by the javascript
+    * WEB-INF - Directory of spring config files
+