Git Product home page Git Product logo

mozaik-ext-github's Introduction

Mozaïk GitHub widgets

License Travis CI NPM version Dependencies Coverage Status widget count

Deploy

This branch contains code for the version compatible with Mozaïk v2, if you're looking for v1, please use mozaik-1 branch.

This repository contains some GitHub widgets to use with Mozaïk.

Demo

You can see a live demo of the widgets here

Widgets

Github Client Configuration

In order to use the Mozaïk github widgets, you should configure its client. It's not required that you provide a token for authentication, but then you'll only be able to see public repos and the rate limit will apply.

parameters

key env key required default description
token GITHUB_API_TOKEN no '' github authentication token
baseUrl GITHUB_BASE_URL no https://api.github.com github api url (useful for enterprise)

usage

# config.yml
api:
  github:
    baseUrl: ""
    token:   MY_GITHUB_TOKEN

Widgets doc

Badges

OrgBadge

Show github organization badge.

github organization badge

parameters
key required description
org yes github organization identifier
title no overrides default title if provided
usage
# config.yml
dashboards:
- # …
  widgets:
  - extension:    github
    widget:       OrgBadge
    organization: github
    columns:      1
    rows:         1
    x:            0
    y:            0

RepoBadge

Show repository info.

parameters
key required description
repository yes github repository
title no overrides default title if provided
usage
# config.yml
dashboards:
- # …
  widgets:
  - extension:  github
    widget:     RepoBadge
    repository: plouc/mozaik
    columns:    1
    rows:       1
    x:          0
    y:          0

UserBadge

Show github user badge.

github user badge

parameters
key required description
user yes github user identifier
title no overrides default title if provided
usage
# config.yml
dashboards:
- # …
  widgets:
  - extension: github
    widget:    UserBadge
    user:      plouc
    columns:   1
    rows:      1
    x:         0
    y:         0

Stats

RepoCommitActivityHistogram

parameters
key required description
repository yes github repository
title no overrides default title if provided
usage
# config.yml
dashboards:
- # …
  widgets:
  - extension:  github
    widget:     RepoCommitActivityHistogram
    repository: plouc/mozaik
    columns:    2
    rows:       1
    x:          0
    y:          0

RepoCommitActivityLine

parameters
key required description
repository yes github repository
title no overrides default title if provided
usage
# config.yml
dashboards:
- # …
  widgets:
  - extension:  github
    widget:     RepoCommitActivityLine
    repository: plouc/mozaik
    columns:    2
    rows:       1
    x:          0
    y:          0

RepoContributorsStats

parameters
key required description
repository yes github repository
title no overrides default title if provided
usage
# config.yml
dashboards:
- # …
  widgets:
  - extension:  github
    widget:     RepoContributorsStats
    repository: plouc/mozaik
    columns:    2
    rows:       1
    x:          0
    y:          0

Traffic

RepoTrafficClonesHistogram

parameters
key required description
repository yes github repository
title no overrides default title if provided
usage
# config.yml
dashboards:
- # …
  widgets:
  - extension:  github
    widget:     RepoTrafficClonesHistogram
    repository: plouc/mozaik
    columns:    2
    rows:       1
    x:          0
    y:          0

RepoTrafficClonesLine

parameters
key required description
repository yes github repository
title no overrides default title if provided
usage
# config.yml
dashboards:
- # …
  widgets:
  - extension:  github
    widget:     RepoTrafficClonesLine
    repository: plouc/mozaik
    columns:    2
    rows:       1
    x:          0
    y:          0

RepoTrafficViewsHistogram

parameters
key required description
repository yes github repository
title no overrides default title if provided
usage
# config.yml
dashboards:
- # …
  widgets:
  - extension:  github
    widget:     RepoTrafficViewsHistogram
    repository: plouc/mozaik
    columns:    2
    rows:       1
    x:          0
    y:          0

RepoTrafficViewsLine

parameters
key required description
repository yes github repository
title no overrides default title if provided
usage
# config.yml
dashboards:
- # …
  widgets:
  - extension:  github
    widget:     RepoTrafficViewsLine
    repository: plouc/mozaik
    columns:    2
    rows:       1
    x:          0
    y:          0

Branches

Show github branches with authors.

github repository branches

parameters

key required description
repository yes github repository
title no overrides default title if provided

usage

# config.yml
dashboards:
- # …
  widgets:
  - extension:  github
    widget:     Branches
    repository: plouc/mozaik
    columns:    1
    rows:       1
    x:          0
    y:          0

PullRequests

Show github repository pull requests with authors.

parameters

key required description
repository yes github repository
title no overrides default title if provided

usage

# config.yml
dashboards:
- # …
  widgets:
  - extension:  github
    widget:     PullRequests
    repository: plouc/mozaik
    columns:    1
    rows:       1
    x:          0
    y:          0

Status

Shows the latest Github system status information from https://status.github.com/

Github Status

usage

# config.yml
dashboards:
- # …
  widgets:
  - extension: github
    widget:    Status
    columns:   1
    rows:      1
    x:         0
    y:         0

mozaik-ext-github's People

Contributors

benediktvaldez avatar plouc avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar avatar avatar avatar

Forkers

swissmanu dotfold brechtvdv backjo tlenclos macklinu stevewilshaw sampengilly contolini puppycodes imranansari gfosco muffinresearch pettersolberg88 zengenti neillboyd callumbrankin deltaevo donkeycode tlake connorrt doodoune

mozaik-ext-github's Issues

Multiple requests for extension?

I need to gather information from two endpoints at the same time. Is there some way to set up multiple request to getApiRequest?

Thanks!

Install fails without exact version (release needed without -beta flag)

Seems that the behavior of NPM has changed: If the module that has no stable release (only ones with -beta flag in version name) available, exact version names are needed on installing:

# Install release with stable release
npm i mozaik-ext-bamboo
OK

# Install module with only -beta releases
npm i mozaik-ext-aws 
npm ERR! Linux 4.0.5-1-ARCH
npm ERR! argv "node" "/usr/bin/npm" "i" "mozaik-ext-aws"
npm ERR! node v0.12.4
npm ERR! npm  v2.11.3
npm ERR! code ETARGET

npm ERR! notarget No compatible version found: mozaik-ext-aws@'*'
npm ERR! notarget Valid install targets:
npm ERR! notarget ["0.0.1-beta","0.0.2-beta","0.0.3-beta","0.0.4-beta","0.0.5-beta","0.0.6-beta","0.0.7-beta","0.0.8-beta","0.0.9-beta","0.0.10-beta","0.0.11-beta","0.0.12-beta"]
npm ERR! notarget 
npm ERR! notarget This is most likely not a problem with npm itself.
npm ERR! notarget In most cases you or one of your dependencies are requesting
npm ERR! notarget a package version that does not exist.

npm ERR! Please include the following file with any support request:
npm ERR!     /home/juha/tmp/moz/npm-debug.log

# Install module with exact version
npm i [email protected]
OK

This issue currently applies with all the mozaik extensions released by you, @plouc. I'd propose to make "stable" releases from each, as it prevents also mozaik-demo to install out of the box.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.