adf-widget-github

GitHub widgest for the angular-dashboard-framework.

Build

The widget is build with the help of node, npm, bower and gulp. For a install instruction for node and npm, please have a look here.

Installing bower and gulp

npm install -g bower
npm install -g gulp

Installing dependencies

npm install
bower install

Build the adf-widget-github

gulp

The compiled and optimized files can be found in the dist directory.

Other build goals

Each goal can be used as parameter for the gulp command.

• clean: removes the dist folder
• lint: checks css and javascript files for common errors
• serve: starts an webserver to test the widget

Usage

Install the widget with bower:

bower install adf-widget-github --save

Include the script and its dependencies in your index.html and be sure it is loaded after angular and after the angular-dashboard-framework.

<script type="text/javascript" src="bower_components/highcharts/adapters/standalone-framework.src.js"></script>
<script type="text/javascript" src="bower_components/highcharts/highcharts.js"></script>
<script type="text/javascript" src="bower_components/highcharts-ng/dist/highcharts-ng.js"></script>
<script type="text/javascript" src="bower_components/adf-widget-github/dist/adf-widget-github.min.js"></script>

Define a dependency for the module:

angular.module('sample', ['adf', 'adf.widget.github']);