greghollenbaugh/uw-frame

An AngularJS application frame for creating uw applications

UW Frame

uw-frame can be described as the "war dependency that you will need to overlay when creating a new My UW 'App'".
uw-frame is a Servlet 2.5 web application that provides provides the primary HTML page at the root of the servlet context that hosts your AngularJS single page application. That includes the My UW header and sidebar:

It does still rely on /portal to be in the same container for the session information (name, server, etc...). If you want to run outside the container just remove those two dependencies and fix the URL's in the side-bar-left.html.

Requirements

• Bower
• Maven
• JDK 7

Getting Started

In your existing Maven war project, add the following dependency:

<dependency>
  <groupId>edu.wisc.my.apps</groupId>
  <artifactId>uw-frame</artifactId>
  <version>x.y.z</version>
  <type>war</type>
</dependency>

(uw-frame is available in The Central Repository.)

uw-frame provides the primary HTML page at the root of the servlet context that hosts your AngularJs single page application. In order to introduce your own content, uw-frame's extension point is 'my-app/main.js'.

Start by creating the folder 'src/main/webapp/my-app' within your Maven war project, and copy uw-frame's main.js in to it. uw-frame includes RequireJS to help you load any additional JavaScript assets you wish, you'll do that in this file.

See my-app-seed for a great starter app using this frame.

Contributing

You can run uw-frame locally with the following command:

mvn install jetty:run

Common Issues

If you see an error like the following from the Maven build, it means you haven't properly installed Bower (check that it's installed and on your path):

[ERROR] Failed to execute goal org.codehaus.mojo:exec-maven-plugin:1.3.2:exec (default) on project uw-frame: Command execution failed. Cannot run program "bower" (in directory "/src/main/webapp"): error=2, No such file or directory -> [Help 1]