Read Me

Quickstart

1. Set the JVM memory in MAVEN_OPTS or JAVA_OPTS:
-Xmx1024m -Xms512m -XX:PermSize=96m -XX:MaxPermSize=192m

2. Build ProjectForge:
mvn -DskipTests=true install

3. Run ProjectForge:
mvn exec:java -Dexec.mainClass="org.projectforge.web.MyStart" -Dexec.classpathScope=test

4. Your browser will be started automatically:
http://localhost:8080/ProjectForge



Build ProjectForge yourself from scratch and deploy it

1. Set the JVM memory in MAVEN_OPTS or JAVA_OPTS:
-Xmx1024m -Xms512m -XX:PermSize=96m -XX:MaxPermSize=192m

2. Build web archive (war) from the command line:
mvn install
Automatical test runs can be supressed:
mvn -DskipTests=true install

3. Please find the ready-to-start web archive (war) in the target sub-directory.


How to proceed?

Configure your Eclipse environment by simply typing into the command line:
mvn eclipse:eclipse


Launch Eclipse and open the project.
1. Add variable M2_REPO: Eclipse -> Preferences -> Java -> Build Path -> Classpath: M2_REPO=/home/kai/.m2/repository
2. Start by simply running main (in src/test/java):
org.projectforge.web.MyStart

Have a lot of fun!

Please note the detailed documentations for administrators, developers as well as for users.

Java version 1.6 is required since ProjectForge 3.4
Please note, that the Java version 1.6 is needed for the development and the running of ProjectForge. There is no delivery for Java 1.5 planned because some third party libraries are only available for Java 1.6.

Adding your own plugins
ProjectForge support plugins. The existing menu can be modified and own entities and functionalities can be added.

The menu is customizable (you can add or remove menu entries in the config.xml file).
Deploy your plugins by adding your(r) jar(s) to the WEB-INF/lib directory. The jars contains both, the Java classes and the web pages (Wicket-pages). Nothing more is needed.
Register your plugins in the config.xml file.
One advantage is that your own plugins are independent from new releases of the ProjectForge core system. In one of the next releases an example plugin will show you how easy it is to extend ProjectForge!