https://github.com/robinradic/github-jquery-widgets

a repo
https://github.com/robinradic/github-jquery-widgets

Last synced: 2 months ago
JSON representation

a repo

• Host: GitHub
• URL: https://github.com/robinradic/github-jquery-widgets
• Owner: RobinRadic
• License: mit
• Created: 2014-12-18T21:42:23.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2015-01-12T18:16:20.000Z (over 11 years ago)
• Last Synced: 2025-02-23T21:09:03.007Z (over 1 year ago)
• Language: JavaScript
• Homepage: http://robinradic.github.io/github-jquery-widgets/
• Size: 1.17 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# github-jquery-widgets

[![Travis build status](https://img.shields.io/travis/RobinRadic/github-jquery-widgets.svg)](http://travis-ci.org/RobinRadic/github-jquery-widgets)

[![NPM Version](https://img.shields.io/npm/v/github-jquery-widgets.svg)](http://npmjs.org/package/github-jquery-widgets)

[![Goto documentation](http://img.shields.io/badge/goto-documentation-orange.svg)](http://robin.radic.nl/github-jquery-widgets)

[![Goto repository](http://img.shields.io/badge/goto-repository-orange.svg)](https://github.com/robinradic/github-jquery-widgets)

[![License](http://img.shields.io/badge/license-MIT-blue.svg)](http://radic.mit-license.org)

[![Example](http://robin.radic.nl/github-jquery-widgets/images/events.jpeg)](http://robin.radic.nl/github-jquery-widgets)

Check out the [demonstration](http://robin.radic.nl/github-jquery-widgets/demo) or [documentation](http://robin.radic.nl/github-jquery-widgets) for more information.

## Getting Started

You can download the zip file and manually extract the files into your project or use either bower, npm or git.

  

### Installing

```bash

# Using bower

bower install --save github-jquery-widgets

# Using node

npm install --save github-jquery-widgets

```

**Dependencies**

- jQuery > 1.9

- jQuery UI Widget Factory

- Handlebars runtime

- RadicJS custom build

  

  

**Optional dependencies**

- spin.js

- jquery.slimscroll.js

  

  

**Written with, by or in**

- Javascript

- SCSS

- Grunt

- Bootstrap 3

### Usage

  

#### Dependencies and widget files

The package ships with seperate files allowing various ways to handle dependencies and to include/exclude widgets.  **tip:** use grunt-usemin or something likewise to concat and minify your js/css.

```html

 

```

  

As an alternative, instead of using the packed radic.githubwidgets.js, you can use the non-packed version. You will have to include `spin.js`, `widget.js` and `handlebars.runtime.js` yourself. An example:

```html

 

```

### Initializing a widget

```javascript

$(function(){

    $('selector').githubProfile({

        username: 'robinradic'

    });

});

```

More information can be found in the [API documentation](http://robin.radic.nl/github-jquery-widgets/)

## Customizing your build

By downloading the source, you can create a customized build. You can alter the HTML templates and SCSS.

  

### Getting started

```bash

git clone https://github.com/robinradic/github-jquery-widgets # or fork->clone a version.

cd github-jquery-widgets

./scripts/bootstrap.sh # This will update-init the radicjs submodule and copy the pre-commit hook that updates the submodule before commiting

npm install

bower install

```

  

**More information soon**

## License

Copyright 2014 Robin Radic 

[MIT Licensed](http://radic.mit-license.org)