settinghead / common-header

Common header to be used across all Rise Vision projects

Rise Vision Common Header

Introduction

A responsive AngularJS-based common header implementation to be used across Rise Vision web applications and pages.

Rise Vision Common Header 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

• ng-gapi-loader
• ng-core-api-client
• angular-ui-flow-manager
• NPM (node package manager)
• Bower
• AngularJS
• Gulp
• Karma and Protractor for testing
• Rise Vision Gulp Factory

Development

• Development FAQ
• Developer's Guide

Prerequisites

• NPM (node package manager)
• Bower
• (Optional) Karma and Protractor for running tests

Local Development Environment Setup and Installation

npm run dev

Run Local

gulp server-watch

And navigate to http://localhost:8099/test/e2e/index.html

bower.json

"dependencies": {
  "rise-vision-common-header": "https://github.com/Rise-Vision/common-header.git"
}

html

Be sure to load angular first. Then....

    <!-- build:js script/common-header.min.js -->
    <script src="components/common-header/dist/common-header.js"></script>
    <!-- endbuild -->

    <!-- build:jsdev nothing-->
    <script src="components/common-header/src/common-header.js"></script>
    <!-- endbuild -->

gulpfile.js

For the build output, process the html file with gulp-usemin, ensuring the js target is included and the jsdev target is ignored so that it gets removed from the html file. ...

.pipe(usemin({
  js: [uglify({mangle:false, outSourceMap: true})]
})
.pipe(gulp.dest("dist/");

Testing

To run all tests at once, do

npm run test

Unit Testing

gulp test:unit

Protractor End-to-End Testing

A mock Google API server is included for End-to-End testing. To run tests, do

gulp test:e2e

npm run test

Unit Testing

gulp test:unit

Protractor End-to-End Testing

A mock Google API server is included for End-to-End testing. To run tests, do

gulp test:e2e

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

In order to support languages i18n needs to be added to this repository. Please refer to our Suggested Contributions.

Suggested Contributions

• Add more broadcast events as needed
• I18n support

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

• Xiyang Chen
• Varun Vachhar