https://github.com/settinghead/common-header
Common header to be used across all Rise Vision projects
https://github.com/settinghead/common-header
Last synced: 9 months ago
JSON representation
Common header to be used across all Rise Vision projects
- Host: GitHub
- URL: https://github.com/settinghead/common-header
- Owner: settinghead
- License: other
- Created: 2014-08-07T17:58:44.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2014-12-12T04:47:17.000Z (over 11 years ago)
- Last Synced: 2025-06-21T16:44:10.692Z (11 months ago)
- Language: JavaScript
- Size: 6.06 MB
- Stars: 0
- Watchers: 1
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Rise Vision Common Header [](https://circleci.com/gh/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](http://www.risevision.com), the [digital signage management application](http://rva.risevision.com/) that runs on [Google Cloud](https://cloud.google.com).
At this time Chrome is the only browser that this project and Rise Vision supports.
## Built With
- [ng-gapi-loader](https://github.com/Rise-Vision/ng-gapi-loader.git)
- [ng-core-api-client](https://github.com/Rise-Vision/ng-core-api-client.git)
- [angular-ui-flow-manager](https://github.com/Rise-Vision/angular-ui-flow-manager.git)
- [NPM (node package manager)](https://www.npmjs.org/)
- [Bower](http://bower.io/)
- [AngularJS](https://https://angularjs.org/)
- [Gulp](http://gulpjs.com/)
- [Karma](https://github.com/karma-runner/karma) and [Protractor](https://github.com/angular/protractor) for testing
- [Rise Vision Gulp Factory](https://github.com/Rise-Vision/widget-tester.git)
## Development
- [Development FAQ](http://rise-vision.github.io/dev-hub-prod/#/documentation/common-header/faq.html)
- [Developer's Guide](http://help.risevision.com/#/developer/common-header/common-header)
### Prerequisites
- [NPM (node package manager)](https://www.npmjs.org/)
- [Bower](http://bower.io/)
- (Optional) [Karma](https://github.com/karma-runner/karma) and [Protractor](https://github.com/angular/protractor) for running tests
### Local Development Environment Setup and Installation
``` bash
npm run dev
```
### Run Local
``` bash
gulp server-watch
```
And navigate to http://localhost:8099/test/e2e/index.html
#### bower.json
``` js
"dependencies": {
"rise-vision-common-header": "https://github.com/Rise-Vision/common-header.git"
}
```
#### html
Be sure to load angular first. Then....
``` html
```
#### 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.
...
``` js
.pipe(usemin({
js: [uglify({mangle:false, outSourceMap: true})]
})
.pipe(gulp.dest("dist/");
```
### Testing
To run all tests at once, do
``` bash
npm run test
```
#### Unit Testing
``` bash
gulp test:unit
```
#### Protractor End-to-End Testing
A mock Google API server is included for End-to-End testing. To run tests, do
``` bash
gulp test:e2e
```
``` bash
npm run test
```
#### Unit Testing
``` bash
gulp test:unit
```
#### Protractor End-to-End Testing
A mock Google API server is included for End-to-End testing. To run tests, do
``` bash
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](http://community.risevision.com), 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](https://github.com/settinghead "Xiyang Chen")
* [Varun Vachhar](https://github.com/winkervsbecks "Varun Vachhar")