Difference between revisions of "Developer Guide"

From OpenKM Documentation
Jump to: navigation, search
Line 95: Line 95:
  
  
 +
[[File:Okm_dev_guide_011.jpeg‎]]
 +
 +
 +
In case you're making strong changes in OpenKM UI ( GWT ) we recomend disabling pom compile directive
 +
 +
<source lang="xml">
 +
<plugin>
 +
        <groupId>org.codehaus.mojo</groupId>
 +
        <artifactId>gwt-maven-plugin</artifactId>
 +
        <version>1.1</version>
 +
        <configuration>
 +
            <runTarget>es.git.openkm.frontend.Main/index.html</runTarget>
 +
        </configuration>
 +
        <executions>
 +
          <execution>
 +
            <goals>
 +
              <!-- <goal>compile</goal> -->
 +
              <!-- <goal>generateAsync</goal>  -->
 +
              <goal>test</goal>
 +
            </goals>
 +
          </execution>
 +
        </executions>
 +
      </plugin>
 +
</source>
  
 
[[Category: OpenKM 4.0]]  
 
[[Category: OpenKM 4.0]]  
 
[[Category: OpenKM 5.0]]
 
[[Category: OpenKM 5.0]]

Revision as of 18:29, 21 January 2010

You need to install Maven, eclipse IDE and some plugins.

For OpenKM 4.0


Configuring maven

Refer to maven installation at http://maven.apache.org/download.html#Installation

Really we'll use maven in operating system console only for some special operations like installing external libraries.


In GNU Linux Ubuntu for example you could be good adding it in .bashrc

export PATH=$PATH:/home/jllort/software/apache-maven-2.2.1/bin


Configuring java to eclipse

Go to Window / Preferences / Java / Installed JRE. You must have JDK 1.6 defined here.


Okm dev guide 004.jpeg


Okm dev guide 005.jpeg


Checkout OpenKM from svn

Go to File / New / Other and select Maven / Checkout Maven Projects from SCM


Okm dev guide 001.jpeg


Select the svn type and typewrite the url https://openkm.svn.sourceforge.net/svnroot/openkm/branches/4.0/openkm to refer version 4.0.


Okm dev guide 002.jpeg


Okm dev guide 003.jpeg


Be patient, first time you downloading OpenKM from svn, you're downloading all libraries to your maven repository. It could need some hours depending your Internet connection.

After OpenKM it'll be donwloaded, automatically it'll be compiled


Installing external libraries to maven repository

Open an operating system console. Go to your OpenKM project path in your file system. Come into ext-libs and execute install.sh ( Windows users simply open this file with text editor and execute the command )


Execute packaging

Into eclipe select openkm root folder.

Open contextual menu and select Run As / Maven Package OpenKM.War it'll be appears created under target folder


Okm dev guide 006.jpeg


Configuring jboss server

Go to servers tab. Using contextual menus select Add / server

Select jboss server


Okm dev guide 007.jpeg


Okm dev guide 008.jpeg


Okm dev guide 009.jpeg


Okm dev guide 010.jpeg


Recomendations

We recomend donwloading jboss+openkm from sourceforge, remove OpenKM.war and develop with this jboss server configuration.

For better developement we recomend not deploying OpenKM.war file it's better setting in $JBOSS_HOME/server/default/deploy some alias to target/OpenKM folder


Okm dev guide 011.jpeg


In case you're making strong changes in OpenKM UI ( GWT ) we recomend disabling pom compile directive

<plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>gwt-maven-plugin</artifactId>
        <version>1.1</version>
        <configuration>
            <runTarget>es.git.openkm.frontend.Main/index.html</runTarget>
        </configuration>
        <executions>
          <execution>
            <goals>
               <!-- <goal>compile</goal> -->
              <!-- <goal>generateAsync</goal>  -->
              <goal>test</goal>
            </goals>
          </execution>
        </executions>
      </plugin>