@uportal/app-framework

    16.0.2 • Public • Published

    uPortal-app-framework

    Questions? Get in touch.

    npm version Maven Central

    Build Status

    dependencies Status devDependencies Status Dependency Status Greenkeeper badge

    Coverage Status

    bitHound Overall Score

    Time to PR close Time to issue close

    CII Best Practices Semver Keep a Changelog Google code style

    uPortal ecosystem incubating badge Apereo Incubating badge

    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 :

    uPortal app framework screenshot

    Learn more about the reusable components on our docs page

    Requirements

    Java (only if you want a maven artifact)

    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:

    <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.)

    Start by creating the folder 'src/main/webapp/my-app' within your Maven war project, and copy uportal-app-framework's main.js in to it. uportal-app-framework 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.

    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:

    npm test

    Running locally

    To build and run on a Superstatic server:

    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:

    cd docs
    
    bundle exec jekyll serve

    You may need to install the Jekyll bundler on your machine. See Jekyll's quick-start guide for instructions.

    Install

    npm i @uportal/app-framework

    DownloadsWeekly Downloads

    1

    Version

    16.0.2

    License

    Apache-2.0

    Unpacked Size

    4.91 MB

    Total Files

    270

    Last publish

    Collaborators

    • apetro
    • bjagg
    • cbeach47
    • christianmurphy
    • doug.reed
    • drewwills
    • jgribonvald
    • nogalpaulina
    • sibley
    • vertein
    • zeke.witter