Rise Distribution Web Component

Introduction

rise-distribution is a Polymer Web Component that works with Rise Vision, the digital signage management application for Web Designers. It controls whether or not a Playlist, or content inside of a Playlist, shows on a Display given a particular Display ID.

At this time Chrome is the only browser that this project and Rise Vision supports.

Usage

To begin, you will need to install the following components using Bower:

bower install https://github.com/Rise-Vision/rise-page.git
bower install https://github.com/Rise-Vision/rise-playlist.git
bower install https://github.com/Rise-Vision/rise-playlist-item.git
bower install https://github.com/Rise-Vision/rise-distribution.git

The above repositories, as well as their dependencies, are installed in the bower_components folder.

Next, construct your HTML page. You should include webcomponents-lite.min.js before any code that touches the DOM, and load the web components using HTML imports. For example:

<rise-page id="page" display-id="your-display-id">
  <rise-playlist id="playlist">
    <rise-playlist-item duration="3">
      <!-- Your content here. -->
    </rise-playlist-item>
    <rise-distribution distribution='[{"id":"your-display-id"}]'>
    </rise-distribution>
  </rise-playlist>
</rise-page>

Note: All playlist and content elements must be assigned a unique id attribute.

Documentation

For further documentation on rise-distribution properties, methods, and usage, please see here.

Built With

Development

Dependencies

Git - Git is a free and open source distributed version control system that is used to manage our source code on Github.
npm & Node.js - npm is the default package manager for Node.js. npm runs through the command line and manages dependencies for an application. These dependencies are listed in the package.json file.
Bower - Bower is a package manager for Javascript libraries and frameworks. All third-party Javascript dependencies are listed in the bower.json file.
Gulp - Gulp is a Javascript task runner. It lints, runs unit and E2E (end-to-end) tests, minimizes files, etc. Gulp tasks are defined in gulpfile.js.
Polyserve - A simple web server for using bower components locally.

Local Development Environment Setup and Installation

To make changes to the web component, you'll first need to install the dependencies:

Git
Node.js and npm
Bower - To install Bower, run the following command in Terminal: npm install -g bower. Should you encounter any errors, try running the following command instead: sudo npm install -g bower.
Gulp - To install Gulp, run the following command in Terminal: npm install -g gulp. Should you encounter any errors, try running the following command instead: sudo npm install -g gulp.
Polyserve - To install Polyserve, run the following command in Terminal: npm install -g polyserve. Should you encounter any errors, try running the following command instead: sudo npm install -g polyserve.

The web component can now be installed by executing the following commands in Terminal:

git clone https://github.com/Rise-Vision/rise-distribution.git
cd rise-distribution
npm install
bower install

Testing

You can run the suite of tests from the command line or via a local web server using Polyserve.

Command Line

Execute the following command in Terminal to run the tests:

gulp test

Local Server

Run the polyserve command in Terminal.

In your browser, navigate to:

http://localhost:8080/components/rise-distribution/test/

Deployment

Once you are satisifed with your changes, deploy rise-distribution.html and the bower_components/polymer and bower_components/webcomponentsjs folders to your server. You can then use the web component by following the Usage instructions above.

Submitting Issues

If you encounter problems or find defects we really want to hear about them. If you could take the time to add them as issues to this Repository it would be most appreciated. When reporting issues, please use the following format where applicable:

Reproduction Steps

did this
then that
followed by this (screenshots / video captures always help)

Expected Results

What you expected to happen.

Actual Results

What actually happened. (screenshots / video captures always help)

Contributing

All contributions are greatly appreciated and welcome! If you would first like to sound out your contribution ideas, please post your thoughts to our community, otherwise submit a pull request and we will do our best to incorporate it. Please be sure to submit test cases with your code changes where appropriate.

Resources

If you have any questions or problems, please don't hesitate to join our lively and responsive community at http://community.risevision.com.

If you are looking for user documentation on Rise Vision, please see https://help.risevision.com/user.

If you would like more information on developing applications for Rise Vision, please visit https://help.risevision.com/developer.

Facilitator

Donna Peplinskie

rise-vision / rise-distribution Goto Github PK

rise-distribution's Introduction