Getting Started

Protorabbit is a servlet and will run on any Java EE container including Tomcat, Jetty, Glassfish.

To setup you need to :

1. Include the protorabit jar, and org.json.jar files in your WEB-INF/lib directory
2. Include the servlet reference, servlet mapping, template references, other parameters in your web.xml
3. Include the CSS template files you plan to use.
4. Include the a JSON template.

Here is a more detailed review of what you need to do:

1. Include the protorabit jar file in your WEB-INF/lib directory – Currently you will need to build these files.
2. Include the servlet reference, servlet mapping, template references, other parameters in your web.xml
   This step is essential and will require a restart once completed.
   

   
   
     
   
      Template Definitions – Order only matters in that the templates further
   
                   to the left will override properties defined to those to the right.   
      prt-templates
      /WEB-INF/templates.json,/resources/blueprint/blueprint-templates.json
   
   
      Turn on development mode. Files will reload on save in this mode.
      prt-dev-mode
      true
   
   
     ProtoRabbit Servlet
     org.protorabbit.servlet.ProtoRabbitServlet
     1
   
   
     ProtoRabbit Servlet
     *.prt
   
   
     ProtoRabbit Servlet
     /prt
   
   

   You may chose a different file extension if you choose but currently the “/prt” servlet mapping is required. We will try to make this configurable in the future.

3. Include the CSS template files you plan to use.
   
   We recommend the Blueprint CSS or Yahoo Grid template frameworks. Both work well with Protorabbit. Please see the samples for pre-configured framework setup.
4. Include the a JSON template.

Make sure to include the template.json files were defined in your web.xml. The samples contain may basic examples of templates.

It is highly recommended that you look at the sample applications for reference on getting started.