auto-scroll

Introduction

Auto-scroll is a jQuery plugin that can be integrated into Widgets to enable auto-scroll and swipe functionality.

Auto-scroll works in conjunction with Rise Vision, the digital signage management application that runs on Google Cloud.

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

Built With

• Polymer
• npm
• Bower
• Gulp
• GSAP
• ThrowPropsPlugin
• Polyserve
• web-component-tester for testing

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 Auto scroll, 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.

Auto scroll can now be installed by executing the following commands in Terminal:

git clone https://github.com/Rise-Vision/auto-scroll.git
cd auto-scroll
npm install
bower install

Testing

You can run the suite of tests either by command terminal or via a local web server using Polyserve.

Command Terminal

Execute the following command in Terminal to run tests:

gulp test

Local Server

Run the following command in Terminal: polyserve.

Now in your browser, navigate to:

localhost:8080/components/auto-scroll/test/index.html

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

1. did this
2. then that
3. 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.

Languages

If you would like to translate the user interface for this product to another language please complete the following:

• Download the English translation file from this repository.
• Download and install POEdit. This is software that you can use to write translations into another language.
• Open the translation file in the POEdit program and set the language for which you are writing a translation.
• In the Source text window, you will see the English word or phrase to be translated. You can provide a translation for it in the Translation window.
• When the translation is complete, save it with a .po extension and email the file to support@risevision.com. Please be sure to indicate the Widget or app the translation file is for, as well as the language that it has been translated into, and we will integrate it after the translation has been verified.

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 http://www.risevision.com/help/users/

If you would like more information on developing applications for Rise Vision please visit http://www.risevision.com/help/developers/.

Facilitator

Donna Peplinskie