Alternative UI for Apereo uPortal (originally built for MyUW)
JavaScript HTML CSS Java Other
Switch branches/tags
v7.0.2 v7.0.1 uportal-home-parent-8.3.3 uportal-home-parent-8.3.2 uportal-home-parent-8.3.1 uportal-home-parent-8.3.0 uportal-home-parent-8.2.1 uportal-home-parent-8.2.0 uportal-home-parent-8.1.2 uportal-home-parent-8.1.1 uportal-home-parent-8.0.0 uportal-home-parent-7.2.0 uportal-home-parent-7.1.0 uportal-home-parent-7.0.3 uportal-home-parent-7.0.2 uportal-home-parent-7.0.1 uportal-home-parent-7.0.0 ap-4.2.1.4 angularjs-portal-parent-6.7.0 angularjs-portal-parent-6.6.0 angularjs-portal-parent-6.5.0 angularjs-portal-parent-6.4.2 angularjs-portal-parent-6.4.1 angularjs-portal-parent-6.4.0 angularjs-portal-parent-6.3.0 angularjs-portal-parent-6.2.2 angularjs-portal-parent-6.2.1 angularjs-portal-parent-6.2.0 angularjs-portal-parent-6.1.0 angularjs-portal-parent-6.0.0 angularjs-portal-parent-5.5.0 angularjs-portal-parent-5.4.1 angularjs-portal-parent-5.4.0 angularjs-portal-parent-5.3.0 angularjs-portal-parent-5.2.4 angularjs-portal-parent-5.0.1 angularjs-portal-parent-5.0.0 angularjs-portal-parent-4.2.1.6 angularjs-portal-parent-4.2.1.5 angularjs-portal-parent-4.2.1.3 angularjs-portal-parent-4.2.1.2 angularjs-portal-parent-4.2.1.1 angularjs-portal-parent-4.1.1.31 angularjs-portal-parent-4.1.1.30 angularjs-portal-parent-4.1.1.23 angularjs-portal-parent-4.1.1.22 angularjs-portal-parent-4.1.1.21 angularjs-portal-parent-4.1.1.19 ajsp-5.2.3 ajsp-5.2.2 ajsp-5.2.1 ajsp-5.2.0 ajsp-5.1.1 ajsp-5.1.0 ajsp-5.0.2 ajsp-4.2.1.7 8.1.0 4.1.1.29 4.1.1.28 4.1.1.27 4.1.1.26 4.1.1.25 4.1.1.24 4.1.1.20 4.1.1.18 4.1.1.17 4.1.1.16 4.1.1.15 4.1.1.14 4.1.1.13 4.1.1.12 4.1.1.11 4.1.1.10 4.1.1.9 4.1.1.8 4.1.1.7 4.1.1.6 4.1.1.5 4.1.1.4 4.1.1.3 4.1.1.2 4.1.1.1
Nothing to show
Clone or download
Permalink
Failed to load latest commit information.
.codenvy/runners/environments/Multinode-tc7-j7 Apply license headers to source files (#690) Sep 13, 2017
.github docs: consistently name the product `uPortal-home` Oct 2, 2017
docs docs(incubation): fix broken link to Apereo website Jul 11, 2018
mock-portal chore(release):prepare for next development iteration Aug 7, 2018
src/main/webapp docs: consistently name the product `uPortal-home` Oct 2, 2017
web chore(release):prepare for next development iteration Aug 7, 2018
.editorconfig Apply license headers to source files (#690) Sep 13, 2017
.gitignore fix: add .vscode to .gitignore Mar 21, 2018
.npmrc build: updating npm package Sep 27, 2017
.travis.yml Merge branch 'master' into refactor/remove-greenkeeper-lockfile Jan 23, 2018
CHANGELOG.md docs: update changelog for 8.3.3 Aug 7, 2018
CODE_OF_CONDUCT.md Acknowledge Apereo Welcoming Policy. (#649) Jun 26, 2017
LICENSE chore(dependency): Acknowledge logback-classic under EPL1.0 Sep 14, 2017
NOTICE chore: NOTICE has to match the extra line at the end Oct 9, 2017
README.md docs(incubation): fix broken link to Apereo website Jul 11, 2018
SUPPORT.md docs(github): Add SUPPORT.md to guide questions to the mailing list Jul 24, 2017
appveyor.yml ci(appveyor): resolve require js flakiness Dec 14, 2017
build.sh docs: consistently name the product `uPortal-home` Oct 2, 2017
committers.md docs: update references to github repos Sep 28, 2017
dependencyci.yml Apply license headers to source files (#690) Sep 13, 2017
package-lock.json chore: sync package-lock.json with package.json Jul 31, 2018
package.json build: make package private Jul 31, 2018
pom.xml chore(release):prepare for next development iteration Aug 7, 2018
update-docs.sh Apply license headers to source files (#690) Sep 13, 2017

README.md

uPortal-home

Questions? Get in touch.

Maven Central Linux and MacOS build status Windows build status Test coverage status devDependencies status bitHound overall score Code Climate Greenkeeper

Semver Keep a Changelog Conventional Commits Google code style

uPortal ecosystem incubating badge Apereo Incubating badge

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

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.