gwtguestbook-namespaces/README.txt

   1 Google App Engine Java Runtime SDK - GWT Guestbook Demo
   2
   3 The GWT Guestbook is a sample application demonstrating how to create and deploy
   4 an application built with GWT on Google App Engine Java Runtime. The Guestbook
   5 uses GWT RPC to store and retrieve guestbook entries and presents a simple UI
   6 to display and enter new guest entries.
   7
   8 This sample application is intended for developers who would like to have a
   9 reference implementation to quickly get started with GWT and the Google App
  10 Engine Java Runtime SDK. For a tutorial on how to create a full-featured GWT
  11 application and deploying it on the Google App Engine Java Runtime, check out
  12 the StockWatcher tutorial on the GWT website at the link below:
  13
  14 http://code.google.com/webtoolkit/tutorials/1.6/index.html
  15
  16
  17 SETUP INSTRUCTIONS
  18
  19 To be able to compile and run the GWT Guestbook sample application, you will
  20 need to download the tools and libraries listed below in addition to the Google
  21 App Engine Java Runtime SDK.
  22
  23 Apache Ant (1.7.1 or higher)  http://ant.apache.org/
  24 --------------------------------------------------------
  25 The Ant build tool is required to compile the GWT Guestbook sample application
  26 as well as startup the Hosted Mode browser. Once downloaded and extracted, you
  27 should configure Ant as prescribed on the homepage (e.g. set an ANT_HOME
  28 environment variable and add the Ant distribution binaries to the system path
  29 variable.
  30
  31 GWT (2.0 or higher)  http://code.google.com/webtoolkit/download.html
  32 --------------------------------------------------------
  33 The GWT libraries are required in order to resolve the usage of the GWT widgets
  34 and RPC subsystem in the Guestbook sample application. See the Getting Started
  35 guide on the GWT homepage for a better understanding on how to configure a GWT
  36 application. For the Guestbook sample application, all you need to do is extract
  37 the GWT distribution to your local drive and define the following properties in
  38 the Guestbook build.properties file:
  39
  40 # Extracted GWT distribution location
  41 gwt.home=<path_to_gwt_sdk>
  42
  43 # App Engine SDK home
  44 appengine.sdk.home=<path_to_app_engine_sdk>
  45
  46 *NOTE: If you are using the Google Eclipse plug-in, you can skip downloading
  47 GWT since it should come bundled with the plug-in itself. You can also
  48 create run configurations in the Eclipse plug-in to compile and run the
  49 Guestbook application in hosted mode, so you can skip the configuration steps
  50 for the build.properties file as well.
  51
  52
  53 RUNNING IN HOSTED MODE
  54
  55 Once you're done with the setup instructions above, you can simply run the
  56 command below while in the Guestbook project root directory:
  57
  58 ant hosted
  59
  60
  61 COMPILING AND DEPLOYING
  62
  63 You can compile the Guestbook sample application by running the command below
  64 while in the Guestbook project root directory:
  65
  66 ant
  67
  68 The GWT compiler will have generated a set of HTML and JavaScript files and
  69 will also have copied over public resources like the Guestbook.css file to a
  70 WAR style output directory. You can then upload your application following the
  71 instructions described in the Google App Engine Java Runtime SDK documentation:
  72
  73 http://code.google.com/appengine/docs/java/gettingstarted/uploading.html
  74
  75
  76 RUNNING UNIT TESTS
  77
  78 There are some GWT client-side and standard server-side unit tests that have
  79 been created to test the application. You must first compile these unit test
  80 classes before you can run them. You can compile them by invoking the following
  81 from command-line:
  82
  83 ant javac-tests
  84
  85 Once you've compiled the unit tests, you can run the GWT client-side tests by
  86 running the following command while in the Guestbook project root directory:
  87
  88 ant gwttest -Dtest=com.google.gwt.sample.gwtguestbook.client.GuestbookTest
  89
  90 To run regular server-side tests, you can use the following Ant command:
  91
  92 ant servertest -Dtest=com.google.gwt.sample.gwtguestbook.server.GuestServiceTest
  93
  94 NAMESPACES
  95
  96 The GWT Guestbook demo also demonstrates how namespaces may be used to create
  97 "namespaced" instances of the application. Namespaces allows a single
  98 application instance to be used for multiple clients. The NamespaceFilter
  99 class contains a servlet filter that may be configured for different
 100 namespace partitioning strategies.