Prerequisites:
You will need the following items to complete these instructions:
Each of the following should be installed on your local system prior to installation of Eclipse.
- Java 1.8 (PC users may require Unlimited Strength Cryptography Extension)
- Tomcat 7 with JDK 1.8
- Database Tunneling Software MIT Kerberos Ticket Manager (PuTTY for Windows)
- SourceTree (https://www.sourcetreeapp.com/)
- Git (https://git-scm.com/download/win)
- Maven (https://maven.apache.org/download.cgi)
AntAccess to the Rice jar files that are the correct version for the version of the KFS project you are creating.Oracle driver jar file
1. Download Eclipse
Expand |
---|
Download and install the Eclipse IDE for Java EE Developers from the following website:http://www.eclipse.org/downloads/. Since the KFS software relies heavily on Spring, the recommended IDE is Spring STS (https://spring.io/tools) After installing, start the Eclipse application. The Select a Workspace dialog will appear. Enter your location where you want to store your Eclipse projects and click OK. |
2. Configure Eclipse
Expand |
---|
Disable automatic building.You may wish to turn off automatic building of the project as it can consume resources when you need them for other things. Select Project->Build Automatically from the Eclipse menu. Ensure that it is unchecked. Once you have the project completely up and running, you should re-enable this feature. Install the formatting rules into your project.Download this eclipse format file: eclipse_format.xml and save it to your local disk. Right-click on your project in the Project Explorer tab and select Properties.
Click Java Code Style->Formatter, then click the Import button and choose eclipse_format.xml file at the location where you saved it. Click Open. Click Apply, then OK.
Select the Java 1.8 JRE within Workspace -> Preferenes -> Java -> Installed JREsNote: Your JDK installation directory may be different than the screenshot: Also set your compiler JDK compliance to 1.8: |
3. Download KFS and RICE from the GIT repository
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Build GIT repository location
Import your projects
|
4. Configure your KFS project
Expand | ||
---|---|---|
Initial build of KFS 5.
Create your local kfs-build.properties file.Copy build/external/user/kfs-build.properties from another developer to your $HOME directory. By default on Windows 7 and higher this is C:/Users/<username> and on Mac OS X it is /Users/<username>
Create your local log4j.properties file.Copy build.external/log4j.properties file to your $HOME directory and edit it as necessary. |
5. Add Tomcat Server
Expand |
---|
Open the Server view by clicking on Window->Show View->Other then select Server from the Show View dialog and click OK.
The Servers tab will appear in the bottom window of Eclipse. Right-click and select New->Server. In the New Server dialog, select Tomcat 7 and click Next.
Browse to the location where you have installed your Tomcat 7 server and then click Finish.
In the Servers tab, double click the Tomcat v7.0 server to open the Server information screen.
Make the following changes to the Server properties:
Click open launch configuration to open the Edit launch configuration properties. Click on the Arguments tab and add the following arguments to the end of the VM arguments field:
Click Apply and then OK. Save and close the Tomcat window.
|
6. Deploy Code to Server
Expand |
---|
Click Window->Show View->Ant to open the Ant view.
Right-click in the Ant window and select Add Buildfiles...
Expand your KFS project and select the build.xml file.
In the Ant view, expand the kfs project and double-click the dist-local target. This will run the ant dist-local target and deploy your code to the Tomcat server. Output messages from ant will display in your Console window. You should see a message similar to the following in your Console window. Of course the path will be the path where you have installed Tomcat locally. [copy] Copying 1 file to /kuali/servers/apache-tomcat-6.0.37/conf/Catalina/localhost |
7. Start the Server
Expand | ||
---|---|---|
The KFS application should now be built and deployed to the Tomcat server.
Refer to this link for instructions on setting up a tunnel to the database:
In the Servers tab, highlight the Tomcat 7 server, and click the Run button (the triangle with a green circle around it). The Console will display messages written during startup of the application. Now, open your browser and go to the URL http://localhost:8080/kfs-dev.
|