praveendandu / apachegui Goto Github PK

The ApacheGUI website is located here http://apachegui.net. Questions and comments can be posted on the forum or sent directly to [email protected].

ApacheGUI Packages are hosted on sourceforge. They can be accessed from the following link https://sourceforge.net/projects/apachegui/

ApacheGUI is a Maven enabled web project. The project is portable and can be imported to any Java IDE as a Maven project.

ApacheGUI is dependant on the following project(s). It is not required to download these projects however a large amount of source code uses classes and methods in these projects.

• ApacheConfParser (https://github.com/jrossi227/ApacheConfParser). The code from this project is included as a Maven dependency.

Although Windows is fully supported, it is recommended to use a Linux or Mac OSX distribution when developing ApacheGUI. This is because Apache and Tomcat run more efficiently on IX based distributions.

####Build Dependancies

• Node js
• Maven 2+
• Java 1.6+
• Latest ApacheGUI package

####Linux / Mac OSX build steps

1. Download the latest package from the package site (https://sourceforge.net/projects/apachegui/files/). A Package will follow the naming convention ApacheGUI-{version}.tar.gz.
2. Extract the package to a directory of your choice.
3. Set the apachegui.home property in pom.xml to the location in step 2.
4. Navigate to the root directory in the source project (Where pom.xml is located).
5. Run the Maven builds below.

######Maven options

• mvn clean package -P prod minifies required javascript and builds a new war under the target directory.
• mvn clean package -P dev copies required javascript without minification and builds a new war under the target directory. This task is meant to speed up war builds for development.
• mvn clean install -P prod minifies required javascript and builds a new war under the target directory. The war is then moved from the target directory to [apachegui.home]/tomcat/webapps. This will re-deploy the application.
• mvn clean install -P dev copies required javascript without minification and builds a new war under the target directory. The war is then moved from the target directory to [apachegui.home]/tomcat/webapps. This will re-deploy the application. This task is meant to speed up war builds for development.
• mvn antrun:run -P package stops ApacheGUI and builds a new .tar.gz archive. The .tar.gz archive is put into the package.dir directory that is specified in the pom.xml properties.

####Windows

1. Download the latest package from the package site (https://sourceforge.net/projects/apachegui/files/). A Package will follow the naming convention ApacheGUI-Windows{architecture}-{version}.msi.
2. Install the ApacheGUI msi.
3. Set the apachegui.home property in pom.xml to the location in step 2. The install location is usually located under C:\Program Files\ApacheGUI
4. Navigate to the root directory in the source project (Where pom.xml is located).
5. Run the Maven builds below.

######Maven options

• mvn clean package -P prod minifies required javascript and builds a new war under the target directory.
• mvn clean package -P dev copies required javascript without minification and builds a new war under the target directory. This task is meant to speed up war builds for development.
• mvn clean install -P prod minifies required javascript and builds a new war under the target directory. The task then stops ApacheGUI, moves the war from the target directory to [apachegui.home]/tomcat/webapps and starts ApacheGUI. This will re-deploy the application.
• mvn clean install -P dev copies required javascript without minification and builds a new war under the target directory. The task then stops ApacheGUI, moves the war from the target directory to [apachegui.home]/tomcat/webapps and starts ApacheGUI. This will re-deploy the application. This task is meant to speed up war builds for development.