[jboss-svn-commits] JBL Code SVN: r9994 - labs/jbossrules/trunk/drools-jbrms.

Tue Mar 6 00:09:58 EST 2007

Author: michael.neale at jboss.com
Date: 2007-03-06 00:09:58 -0500 (Tue, 06 Mar 2007)
New Revision: 9994

Added:
   labs/jbossrules/trunk/drools-jbrms/build-readme.html
Removed:
   labs/jbossrules/trunk/drools-jbrms/README.txt
Log:
updated build doco

Deleted: labs/jbossrules/trunk/drools-jbrms/README.txt
===================================================================

--- labs/jbossrules/trunk/drools-jbrms/README.txt	2007-03-06 01:12:12 UTC (rev 9993)
+++ labs/jbossrules/trunk/drools-jbrms/README.txt	2007-03-06 05:09:58 UTC (rev 9994)
@@ -1,27 +0,0 @@
-This covers the instructions on how to build/develop with this module.
-
-It uses maven 2 as the main build system (pom.xml) which will setup the dependencies.
-When building into a war, or running unit tests, use
-
->mvn package
-
-GWT is used to build the UI. This is what the ant build script is for.
-If you take a look at build.properties, you may need to change the gwt.home path to be 
-relevant for you.
-
-Download GWT if you want to mess with the UI.
-
-In eclipse: this also has a eclipse project file setup for you.
-You will need to have the M2_REPO variable setup.
-
-You can run all unit tests from here of course. You can also run GWT in 
-"hosted" mode (unless you are on the mac). To do this, there is a JBRMS-launch configuration
-for eclipse (when you select Run>Run from the menu, it should provide a JBRMS run config). 
-If you are debugging GWT this way, you will need the GWT_HOME variable
-set to where you have installed GWT (and if you are on windows, change the jar
-to the one for you).
-
-To make a change in GWT - when you are finished debugging, you will need to run
-the ant build script to refresh the static web content (all the AJAXY shite).
-
-Any questions, contact michael.neale at gmail.com or find me in IRC.

Added: labs/jbossrules/trunk/drools-jbrms/build-readme.html
===================================================================
--- labs/jbossrules/trunk/drools-jbrms/build-readme.html	                        (rev 0)
+++ labs/jbossrules/trunk/drools-jbrms/build-readme.html	2007-03-06 05:09:58 UTC (rev 9994)
@@ -0,0 +1,3 @@
+<html><head>
+      <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+   <title>Introduction</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1"></a>Introduction</h2></div></div><hr></div><p>This section covers the innards of the BRMS - it is not neccesary to use this if you are integrating or an end user of the BRMS application. However, JBoss Rules is open source, so build instructions form part of the manual.</p><p>You may want to build from source if you want to re-use components, or embed the application in your own.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e8"></a>Design</h3></div></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e11"></a>Building!
  from source</h3></div></div></div><p>This section will go over the steps you will need to take to build various components. Mostly this is automated, but the manual process is described for thoroughness.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e16"></a>Modules</h4></div></div></div><p>There are 2 modules: drools-repository (back end) and drools-jbrms (front end and rules integration). The drools-jbrms module depends on the drools-repository module, as well as other components.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e21"></a>Working with Maven 2</h4></div></div></div><p>Maven 2 is used as the underlying build system. To get started, you will need to check out the WHOLE of the source tree for JBoss Rules. This includes the other modules, and the top level lib and repository directories (which are needed by the build). As the BRMS build is part of the main dr!
 ools build.</p><p>Initially, you should go into the root of the jboss-
rules checked out source tree, and run mvn install to install all the components for the inter project depedencies. If the build is broken (no ! say it isn't so !) you can use the flag -Dmaven.test.skip=true to prevent failing unit tests from preventing the build.</p><p>As the BRMS depends on drools-repository (which is the back end version storage subsystem), you then go into the drools-repository directory, and run "mvn install" to make it available. Finally, you can go into the drools-jbrms directory and run "mvn test" to check it all works, or "mvn package" to generate the web application (as well as run the tests). You should now be good to go !</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e30"></a>Working with GWT</h4></div></div></div><p>The GUI widgets for the web front end are developed with GWT (google web toolkit). If you need to make changes to or build the GUI, you will need to download GWT seperately. Onc!
 e GWT is downloaded, you can modify the build.properties file in the drools-jbrms directory to point to where you installed GWT. Once you have this, you can use the ant tasks to build the GWT components, as well as launch GWT in debug/hosted mode should you desire. If you run the build, it will update the webapp directory in the project with the new "compiled" artifacts (GWT does not use JSP, only html and javascript at runtime).</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e35"></a>Debugging, Editing and running with Eclipse</h4></div></div></div><p>Each module has a ready to go and up to date eclipse project configuration, so you can just import them into your eclipse workspace. These projects are generated by maven (mvn eclipse:eclipse to refresh them). They have been manually modified to have project dependencies (means you can step through code when debugging).</p><p>Some environment variables are required in ecl!
 ipse (Window-&gt;Preferences-&gt;Java-&gt;Build path-&gt;Classpath var
iables): the M2_REPO, as normal, to point to where maven downloads shared dependencies. GWT_HOME should point to where you installed GWT. GWT_DEV must point to the platform specific "dev" jar that ships with the version of GWT you have.</p><p>How you launch from eclipse: you can launch unit test, as normal (in which case you only need M2_REPO setup - you don't even need to download GWT seperately) - OR, you can launch it in "hosted mode" using the GWT browser, which is great for debugging (from GUI to back end, you can step through code, and make changes on the fly and simply hit refresh). There is a JBRMS.launch file in in the drools-jbrms directory. This should allow Eclipse to launch the JBRMS in debug mode - open the Run dialog (Run-&gt;Run), and then choose "JBRMS" from the list. Launching this will open a new window, with the BRMS in debug mode, ready to go.</p><p>Downloading and debugging the BRMS with GWT is optional, and if you are only working on non GUI issues, yo!
 u can skip this step.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e46"></a>Re-usable components</h3></div></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e49"></a>Versioning and Storage</h3></div></div></div></div></div></body></html>
\ No newline at end of file


Property changes on: labs/jbossrules/trunk/drools-jbrms/build-readme.html
___________________________________________________________________
Name: svn:eol-style
   + native


