These instructions are designed to quickly get you up and running with KFS. They are not designed for deploying the application to a server environment.
To implement KFS, a developer should have a good working knowledge of the following:
Please see Financials Coding Standards for more details
Set up your Development Environment
KFS is currently IDE agnostic. As of KFS 6, no IDE metadata is stored in SCM and KFS should work with multiple IDEs including Eclipse and IntelliJ. |
Configure KFS
Also see the build process page. |
-Dadditional.kfs.config.locations
property. Note, if you are using Oracle, you need to install the jdbc jar in your local maven repository using a command such as the following: mvn install:install-file -Dfile={Path/to/your/ojdbc.jar} -DgroupId=com.oracle -DartifactId=ojdbc6 -Dversion=11.2.0.3 -Dpackaging=jar You will also need to specify the Oracle profile for maven by using the -P oracle command line switch when running Oracle in addition to overriding the appropriate database settings. |
Build KFS
npm login --registry https://npm.kuali.co (one time setup)
mvn -DskipTests=true package
Note, the -DskipTests=true is optional, but if you don't skip the tests, they will take some time to run and aren't strictly necessary for packaging the KFS war. For iterative development, you may also want to add -Dhelp.skip=true to the build command line. This skips the unpacking and deployment of the help files, significantly reducing the build time. |
configure tomcat to use the war created in the previous step in your preferred way(via ide, standalone tomcat, etc)
Copy your jdbc driver into the tomcat lib folder
pass the following property into tomcat at runtime: -Dadditional.kfs.config.locations=path_to_override_config.properties
http://localhost:8080/kfs-dev/
by default)mvn -Dadditional.kfs.config.locations=path_to_override_config.properties test