stetrevor / uportal-home

Alternative UI for Apereo uPortal (originally built for MyUW)

uPortal-home

Questions? Get in touch.

What is this?

uPortal-home is an alternative user interface for some of the most frequent user interactions in uPortal, namely

• home page
• widgets
• app directory
• search
• rendering static content
• rendering simple Portlets

This alternative user interface is implemented using AngularJS as a client-side in-browser experience. It relies upon uPortal (through uPortal REST APIs) and delegates to uPortal for the user experiences that uPortal-home doesn't directly implement or inline (so, for more complex JSR-286 Portlet experiences).

See this project's documentation.

Resources for understanding what you can do with uPortal-home

• MyUW Overview slide deck
• MyUW Introduction YouTube video
• MyUW KnowledgeBase

Building

• Generate endpoint.properties

cd uportal-home
cp web/src/main/resources/endpoint.properties.example web/src/main/resources/endpoint.properties

This file contains your server side proxy configurations. See the example file for examples

• run mvn clean package from the root directory to build the war files.

Building, Deploying, and Running with Apereo uPortal

See documentation site.

Modules

Frame

uPortal-home is a uPortal App-Framework project.

Home

This is the portal home page. It uses the frame as a base then adds in the layout, app directory, and features pages.

To deploy the home build from the base directory described above. Then cd ./web and run mvn tomcat7:redeploy (assuming you have auto deploy configured). The home will now be deployed to /web.

Running w/ Mock Data

To run simply type mvn clean package && mvn jetty:run from the root directory. By default Jetty runs on port 8080.

Deploying to a Running Local Tomcat

We added in support to deploy the artifact to Tomcat using Maven. To setup add a server to your .m2/settings.xml for Tomcat. Example:

<server>
   <id>TomcatServer</id>
   <username>user</username>
   <password>password</password>
</server>

The id of TomcatServer is important here. Add that user/pass combo to your $TOMCAT_HOME/conf/tomcat-users.xml. Also be sure you have a role of manager listed.

Example:

<role rolename="manager"/>
<user username="user" password="password" roles="manager-script"/>

The role of manager-script gives them the ability to use the /text api from Tomcat.

Read more about how this works in Tomcat documentation.

With this you can run mvn tomcat7:deploy or mvn tomcat7:redeploy if you have already deployed it once. We also wrote a script for this. Just run ./build.sh

Deploy to Remote Instance

Drop uportal-home/web/target/web.war in the Tomcat instance that runs uPortal and fire it up. Should just work.

License

This product is licensed to you under the Apache License 2.0.

The binary distribution of this product includes binaries licensed under the Eclipse Public License - v 1.0.