@uportal/app-framework
Version:
Application Framework for uPortal
125 lines (82 loc) • 7.18 kB
Markdown
# uPortal-app-framework
Questions? [Get in touch][uportal-user@].
<!-- coordinates -->
[](https://badge.fury.io/js/%40uportal%2Fapp-framework)
[](https://maven-badges.herokuapp.com/maven-central/org.apereo.uportal/uportal-app-framework)
<!-- build status -->
[](https://travis-ci.org/uPortal-Project/uportal-app-framework)
<!-- dependencies status -->
[](https://david-dm.org/uPortal-Project/uportal-app-framework)
[](https://david-dm.org/uPortal-Project/uportal-app-framework?type=dev)
[](https://dependencyci.com/github/uPortal-Project/uportal-app-framework)
[](https://greenkeeper.io/)
<!-- test coverage -->
[](https://coveralls.io/github/uPortal-Project/uportal-app-framework?branch=master)
<!-- quality indicators -->
[](https://www.bithound.io/github/uPortal-Project/uportal-app-framework)
<!-- responsiveness indicators -->
[](http://issuestats.com/github/uPortal-Project/uportal-app-framework)
[](http://issuestats.com/github/uPortal-Project/uportal-app-framework)
<!-- standards and practices used in project -->
[](https://bestpractices.coreinfrastructure.org/projects/1709)
[](http://semver.org/spec/v2.0.0.html)
[](http://keepachangelog.com/en/1.0.0/)
[](https://google.github.io/styleguide/)
<!-- incubation status -->
[](http://uportal-project.github.io/uportal-home/apereo-incubation.html)
[](https://www.apereo.org/content/projects-currently-incubation)
`uPortal-app-framework` is a front-end framework for building web applications that users experience as "apps in the portal".
This package includes the `uPortal-home` header, settings, footer, and some reusable components :
Learn more about the reusable components on our [docs page](http://uportal-project.github.io/uportal-app-framework/)
## Requirements
* [node](https://nodejs.org/en/)
* [npm](https://www.npmjs.com/)
### Java (only if you want a maven artifact)
* [Maven](http://maven.apache.org)
* JDK 7
## Quickstart
uportal-app-framework provides the primary HTML page at the root of the context that hosts your AngularJS single page application. In order to introduce your own content, uportal-app-framework's extension point is 'my-app/main.js'.
### Getting Started with uportal-app-framework
In your existing Maven war project, add the following dependency:
```xml
<dependency>
<groupId>org.apereo.uportal</groupId>
<artifactId>uportal-app-framework</artifactId>
<version>x.y.z</version>
<type>war</type>
</dependency>
```
(uportal-app-framework is [available in The Central Repository](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.apereo.uportal%22%20AND%20a%3A%22uportal-app-framework%22).)
Start by creating the folder 'src/main/webapp/my-app' within your Maven war project, and copy [uportal-app-framework's main.js](components/my-app/main.js) in to it.
uportal-app-framework includes [RequireJS](http://requirejs.org/) to help you load any additional JavaScript assets you wish, you'll do that in this file.
See [my-app-seed](https://github.com/UW-Madison-DoIT/my-app-seed) for a great starter app using this frame.
### Getting Started with static
This gives you the basic frame in a static content type way. Just add your files to the proper directory and you should be all set. This module is still a work in progress. Note it only works right now as the root context (if you want to change, update the index.html). This module is mostly used for development on the frame itself.
In `components/js/app-config.js` set
* `SERVICE_LOC.portalLayoutRestEndpoint` to `/portal/api/layout`, and
* `SERVICE_LOC.widgetApi.entry` to `staticFeeds/`
to source the mock data for the example the home page showcasing some widgets.
### Testing
We love tests. We setup karma to run our tests.
To run the test suite:
```sh
npm test
```
### Running locally
To build and run on a Superstatic server:
```sh
npm run static:dev
```
### Maven
You can also create a artifact using maven. There's a pom.xml file in the
root directory. The maven build will use the normal npm build and
bundle into a deliverable war file.
## Running the documentation
To run the Jekyll docs locally:
```sh
cd docs
bundle exec jekyll serve
```
You may need to install the Jekyll bundler on your machine. See [Jekyll's quick-start guide](https://jekyllrb.com/docs/quickstart/) for instructions.
[uportal-user@]: https://groups.google.com/a/apereo.org/forum/#!forum/uportal-user