[Commits] r1172 - apps/opengeo/geoexplorer/trunk

[commits at geoext.org]

Author: tschaub
Date: 2009-06-30 01:45:08 +0200 (Tue, 30 Jun 2009)
New Revision: 1172

Added:
   apps/opengeo/geoexplorer/trunk/readme-dev.txt
Log:
Adding a readme for people working with the application source.

Added: apps/opengeo/geoexplorer/trunk/readme-dev.txt
===================================================================
--- apps/opengeo/geoexplorer/trunk/readme-dev.txt	                        (rev 0)
+++ apps/opengeo/geoexplorer/trunk/readme-dev.txt	2009-06-29 23:45:08 UTC (rev 1172)
@@ -0,0 +1,78 @@
+=================================
+Running and deploying GeoExplorer
+=================================
+
+These instructions describe how to deploy GeoExplorer assuming you have a copy
+of the application source code from subversion.
+
+Getting a copy of the application
+---------------------------------
+
+To get a copy of the application source code, use subversion::
+
+    you at prompt:~$ svn export http://svn.geoext.org/apps/opengeo/geoexplorer/trunk geoexplorer
+
+
+Running in development mode
+---------------------------
+
+The application can be run in development or distribution mode.  In development
+mode, individual scripts are available to a debugger.  In distribution mode,
+scripts are concatenated and minified.
+
+To run the application in development mode, change into the build director and
+run ant::
+
+    you at prompt:~$ cd geoexplorer/build
+    you at prompt:~/geoexplorer/build$ ant dev
+
+If the build succeeds, everything you need to run the application will be in the
+new build/GeoExplorer directory.  Browse to this directory in your browser (e.g.
+http://localhost/~you/geoexplorer/build/GeoExplorer).
+
+
+Connecting GeoExplorer to a local GeoServer
+-------------------------------------------
+
+The easiest way to run GeoExplorer is to place it in the www folder of a
+GeoServer data dir.
+
+1. Copy the build/GeoExplorer directory to $GEOSERVER_DATA_DIR/www/
+
+2. Modify the "ows" configuration value in GeoExplorer/index.html to reflect the
+path to your GeoServer WMS endpoint (usually "/geoserver/wms").
+
+3. Open the index.html page in a browser (e.g.
+http://localhost:8080/geoserver/www/GeoExplorer/index.html)
+
+
+Preparing the application for deployment
+----------------------------------------
+
+Running GeoExplorer as described above is not suitable for production because
+JavaScript files will be loaded dynamically.  Before moving your application
+to a production environment, follow the steps below.
+
+1. Copy any changes to the app configuration you made in GeoExplorer/index.html
+into the geoexplorer/src/html/index.html file.  Just copy the changes to the
+JavaScript - do not copy the entire contents of the file.
+
+2. If you have not already set up JSTools, do so following the instructions
+you find on the JSTools project page: http://pypi.python.org/pypi/JSTools
+
+3. Run ant to build the application for distribution.
+
+For example, to create a directory that can be moved to your production
+environment, do the following::
+
+    you at prompt:~$ cd geoexplorer/build
+    you at prompt:~/geoexplorer/build$ ant
+
+Move the GeoExplorer directory (from the build directory) to your production
+environment.
+
+If you want to create a zip archive of the application, instead run the
+following:::
+
+    you at prompt:~/geoexplorer/build$ ant zip
+