The Image Widget allows you to add an image directly into your Presentation. This can be an image from Storage, your server or a 3rd party server.
Image Widget 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.
- AngularJS
- jQuery
- Bootstrap
- Spectrum Colorpicker
- i18next
- npm
- Bower
- Gulp
- Protractor, CasperJS, Karma, Mocha, Chai and Chai as Promised for testing
- 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.
To make changes to the Widget, you'll first need to install Git.
The Widget can now be installed by executing the following command at the command line:
git clone https://github.com/Rise-Vision/widget-image.git
If you want to get up and running quickly without having to install npm, Bower and Gulp, then you can make your code changes directly to the files in the dist folder. Please keep in mind that by doing so, you won't be able to take advantage of the many benefits that these tools provide, such as managing dependencies and running automated tests & builds. Should you decide that you would like to use these tools, you will first need to install them:
- 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.
Next, perform these additional steps at the command line:
cd widget-image
npm install
bower install
gulp build
The source code for the Widget can be found in the src folder, and this is where you can make any necessary code changes.
To preview Widgets locally, you'll need to use the Widget Preview app.
Execute the following command in Terminal to run both end-to-end and unit tests:
gulp test
Once you are satisifed with your changes, run gulp build again, which will regenerate the dist folder. The dist folder contains all of the files that need to be deployed to your server. In the Rise Vision Platform, you can then add your custom Widget via the Gadgets tab. Give your Widget a name, select a Type of Widget, paste the link to the widget.html file in the URL field, and the link to the settings.html file in the Custom UI URL field:
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)
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 corresponding E2E and unit tests where appropriate.
If you would like to translate the user interface for this product to another language, please refer to the common-i18n repository.
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