Skip to content
This repository has been archived by the owner on May 4, 2022. It is now read-only.

Commit

Permalink
Merge branch 'master' into rootScope
Browse files Browse the repository at this point in the history
  • Loading branch information
Doug-Reed committed Jun 8, 2018
2 parents 68a9ab7 + c29a6d4 commit 5941936
Show file tree
Hide file tree
Showing 13 changed files with 2,349 additions and 2,823 deletions.
53 changes: 38 additions & 15 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,45 @@ and this project adheres to

## [Unreleased][]

### Deprecated
### Changed

* Support for Font Awesome icons (the `faIcon` parameter in `portlet-definition`
entity files) is formally deprecated, with Material icons (`mdIcon`) preferred
instead. Documentation is updated to reflect this preference and deprecation.
Support for Font Awesome icons will be removed in some future release.
### Added

### Fixed

* Hide app directory search loading indicator when search returns zero results
(#826)
* Suggest ways to recover from a search with zero results (#828)
* Gracefully handle case where directory search JSON URL is bad, as is the case
in naive localhost demo against stub data (#825)

## [8.2.0][] - 2018-06-22

### Changed

* Adjusted "Undo" action toasts to better support rapid widget deletion (#812)
* Removed side navigation link to unused "New Features" page (#814)
* "About" page now actually has information about MyUW (#814)

### Added

* Side navigation link to new "Version information" page (#814)

## [8.1.1][] - 2018-03-30
## [8.1.2][] - 2018-04-17

### Deprecated

* Support for Font Awesome icons (the `faIcon` parameter in `portlet-definition`
entity files) is formally deprecated, with Material icons (`mdIcon`) preferred
instead. Documentation is updated to reflect this preference and deprecation.
Support for Font Awesome icons will be removed in some future release. (#801)

### Fixed

* Adjusted "Undo" action toasts to better support rapid widget deletion (#812)
* Prioritized matching `title`s in search results (#809)
* `.gitignore` `.vscode` (#788)

## [8.1.1][] - 2018-03-30

### Changes

Expand Down Expand Up @@ -389,14 +410,16 @@ See also:

* the [6.0.0 milestone](https://github.com/uPortal-Project/uportal-home/milestone/5?closed=1).

[unreleased]: https://github.com/uPortal-Project/uportal-home/compare/uportal-home-parent-8.1.1...HEAD
[8.1.1]: https://github.com/uPortal-Project/uportal-home/releases/tag/uportal-home-parent-8.1.0...uportal-home-parent-8.1.1
[8.1.0]: https://github.com/uPortal-Project/uportal-home/releases/tag/uportal-home-parent-8.0.0...uportal-home-parent-8.1.0
[8.0.0]: https://github.com/uPortal-Project/uportal-home/releases/tag/uportal-home-parent-7.2.0...uportal-home-parent-8.0.0
[7.2.0]: https://github.com/uPortal-Project/uportal-home/releases/tag/uportal-home-parent-7.1.0...uportal-home-parent-7.2.0
[7.1.0]: https://github.com/uPortal-Project/uportal-home/releases/tag/uportal-home-parent-7.0.3...uportal-home-parent-7.1.0
[7.0.3]: https://github.com/uPortal-Project/uportal-home/releases/tag/uportal-home-parent-7.0.2..uportal-home-parent-7.0.3
[7.0.2]: https://github.com/uPortal-Project/uportal-home/releases/tag/uportal-home-parent-7.0.1...uportal-home-parent-7.0.2
[unreleased]: https://github.com/uPortal-Project/uportal-home/compare/uportal-home-parent-8.2.0...HEAD
[8.2.0]: https://github.com/uPortal-Project/uportal-home/compare/uportal-home-parent-8.1.2...uportal-home-parent-8.2.0
[8.1.2]: https://github.com/uPortal-Project/uportal-home/compare/uportal-home-parent-8.1.1...uportal-home-parent-8.1.2
[8.1.1]: https://github.com/uPortal-Project/uportal-home/compare/uportal-home-parent-8.1.0...uportal-home-parent-8.1.1
[8.1.0]: https://github.com/uPortal-Project/uportal-home/compare/uportal-home-parent-8.0.0...uportal-home-parent-8.1.0
[8.0.0]: https://github.com/uPortal-Project/uportal-home/compare/uportal-home-parent-7.2.0...uportal-home-parent-8.0.0
[7.2.0]: https://github.com/uPortal-Project/uportal-home/compare/uportal-home-parent-7.1.0...uportal-home-parent-7.2.0
[7.1.0]: https://github.com/uPortal-Project/uportal-home/compare/uportal-home-parent-7.0.3...uportal-home-parent-7.1.0
[7.0.3]: https://github.com/uPortal-Project/uportal-home/compare/uportal-home-parent-7.0.2..uportal-home-parent-7.0.3
[7.0.2]: https://github.com/uPortal-Project/uportal-home/compare/uportal-home-parent-7.0.1...uportal-home-parent-7.0.2
[7.0.1]: https://github.com/uPortal-Project/uportal-home/compare/angularjs-portal-parent-7.0.0...uportal-home-parent-7.0.1
[7.0.0]: https://github.com/uPortal-Project/uportal-home/compare/angularjs-portal-parent-6.7.0...uportal-home-parent-7.0.0
[6.7.0]: https://github.com/uPortal-Project/uportal-home/compare/angularjs-portal-parent-6.6.0...angularjs-portal-parent-6.7.0
Expand Down
93 changes: 65 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ Questions? [Get in touch][uportal-user@].

<!-- current project status -->
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apereo.uportal/uportal-home/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apereo.uportal/uportal-home)
[![Linux and MacOS Build Status](https://travis-ci.org/uPortal-Project/uportal-home.svg)](https://travis-ci.org/uPortal-Project/uportal-home)
[![Windows Build status](https://ci.appveyor.com/api/projects/status/80kfnn3469oybst2/branch/master?svg=true)](https://ci.appveyor.com/project/ChristianMurphy/uportal-home/branch/master)
[![Coverage Status](https://coveralls.io/repos/uPortal-Project/uportal-home/badge.svg?branch=master&service=github)](https://coveralls.io/github/uPortal-Project/uportal-home?branch=master)
[![devDependencies Status](https://david-dm.org/uPortal-Project/uportal-home/dev-status.svg)](https://david-dm.org/uPortal-Project/uportal-home?type=dev)
[![bitHound Overall Score](https://www.bithound.io/github/uPortal-Project/uportal-home/badges/score.svg)](https://www.bithound.io/github/uPortal-Project/uportal-home)
[![Linux and MacOS build status](https://travis-ci.org/uPortal-Project/uportal-home.svg)](https://travis-ci.org/uPortal-Project/uportal-home)
[![Windows build status](https://ci.appveyor.com/api/projects/status/80kfnn3469oybst2/branch/master?svg=true)](https://ci.appveyor.com/project/ChristianMurphy/uportal-home/branch/master)
[![Test coverage status](https://coveralls.io/repos/uPortal-Project/uportal-home/badge.svg?branch=master&service=github)](https://coveralls.io/github/uPortal-Project/uportal-home?branch=master)
[![devDependencies status](https://david-dm.org/uPortal-Project/uportal-home/dev-status.svg)](https://david-dm.org/uPortal-Project/uportal-home?type=dev)
[![bitHound overall score](https://www.bithound.io/github/uPortal-Project/uportal-home/badges/score.svg)](https://www.bithound.io/github/uPortal-Project/uportal-home)
[![Code Climate](https://codeclimate.com/github/uPortal-Project/uportal-home/badges/gpa.svg)](https://codeclimate.com/github/uPortal-Project/uportal-home)
[![Greenkeeper badge](https://badges.greenkeeper.io/uPortal-Project/uportal-home.svg)](https://greenkeeper.io/)
[![Greenkeeper](https://badges.greenkeeper.io/uPortal-Project/uportal-home.svg)](https://greenkeeper.io/)

<!-- standards used in project -->
[![Semver](http://img.shields.io/SemVer/2.0.0.png)](http://semver.org/spec/v2.0.0.html)
Expand All @@ -22,46 +22,74 @@ Questions? [Get in touch][uportal-user@].
[![uPortal ecosystem incubating badge](https://img.shields.io/badge/uPortal%20ecosystem-incubating-blue.svg)](http://uportal-project.github.io/uportal-home/apereo-incubation.html)
[![Apereo Incubating badge](https://img.shields.io/badge/apereo-incubating-blue.svg?logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAABmJLR0QA%2FwD%2FAP%2BgvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH4QUTEi0ybN9p9wAAAiVJREFUKM9lkstLlGEUxn%2Fv%2B31joou0GTFKyswkKrrYdaEQ4cZAy4VQUS2iqH%2BrdUSNYmK0EM3IkjaChnmZKR0dHS0vpN%2FMe97TIqfMDpzN4XkeDg8%2Fw45R1XNAu%2Fe%2BGTgAqLX2KzAQRVGytLR0jN2jqo9FZFRVvfded66KehH5oKr3dpueiMiK915FRBeXcjo9k9K5zLz%2B3Nz8EyAqX51zdwGMqp738NSonlxf36Cn7zX9b4eYX8gSBAE1Bw9wpLaW%2BL5KWluukYjH31tr71vv%2FU0LJ5xzdL3q5dmLJK7gON5wjEQizsTkFMmeXkbHxtHfD14WkbYQaFZVMzk1zfDHERrPnqGz4wZ1tYfJ5%2FPMLOYYW16ltrqKRDyOMcYATXa7PRayixSc4%2FKFRhrqjxKGIWVlZVQkqpg1pYyvR%2BTFF2s5FFprVVXBAAqq%2F7a9uPKd1NomeTX4HXfrvZ8D2F9dTSwWMjwywueJLxQKBdLfZunue0Mqt8qPyMHf0HRorR0ArtbX1Zkrly7yPNnN1EyafZUVZLJZxjNLlHc%2BIlOxly0RyktC770fDIGX3vuOMAxOt19vJQxD%2BgeHmE6liMVKuNPawlZ9DWu2hG8bW1Tuib0LgqCrCMBDEckWAVjKLetMOq2ZhQV1zulGVFAnohv5wrSq3tpNzwMR%2BSQi%2FyEnIl5Ehpxzt4t6s9McRdGpIChpM8Y3ATXbkKdEZDAIgqQxZrKo%2FQUk5F9Xr20TrQAAAABJRU5ErkJggg%3D%3D)](https://www.apereo.org/content/projects-currently-incubation)

### What is this?
This is an Angular approach to the dashboard view of uPortal. This dashboard will work along side uPortal, more of a companion app. It utilizes the uPortal rest APIs to collect layout info.
## 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][GitHub Pages site].

#### Resources for understanding what you can do with `uPortal-home`:
### Resources for understanding what you can do with `uPortal-home`

+ [MyUW Overview slide deck][]
+ [MyUW Introduction YouTube video](https://www.youtube.com/watch?v=4kM9pPnH_hA)
+ [MyUW KnowledgeBase](https://kb.wisc.edu/myuw/)

### Building
## Building

+ Generate `endpoint.properties`

```shell
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

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](https://github.com/Jasig/uPortal)
### Building, Deploying, and Running with [Apereo uPortal](https://github.com/Jasig/uPortal)

See [documentation site][GitHub Pages site].

### Modules
## Modules

### Frame

#### Frame
uPortal-home is a [uPortal App-Framework project](https://github.com/uPortal-Project/uportal-app-framework).

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

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`.
This is the portal home page. It uses the frame as a base then adds in the
layout, app directory, and features pages.

### 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.
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:

### 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:
```xml
<server>
<id>TomcatServer</id>
Expand All @@ -70,29 +98,38 @@ We added in support to deploy the artifact to Tomcat using Maven. To setup add a
</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.

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:

```xml
<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][Tomcat docs re Maven plugin].
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][Tomcat docs re Maven plugin].

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`
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
## 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.
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.
The binary distribution of this product includes binaries licensed under the
Eclipse Public License - v 1.0.


[MyUW Overview slide deck]: http://go.wisc.edu/qwg5r1
Expand Down
2 changes: 1 addition & 1 deletion mock-portal/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<parent>
<groupId>org.apereo.uportal</groupId>
<artifactId>uportal-home-parent</artifactId>
<version>8.1.3-SNAPSHOT</version>
<version>8.2.1-SNAPSHOT</version>
</parent>

<artifactId>uportal-home-mock-portal</artifactId>
Expand Down

0 comments on commit 5941936

Please sign in to comment.