{"id":15998145,"url":"https://github.com/plouc/mozaik-ext-github","last_synced_at":"2025-03-18T01:31:24.782Z","repository":{"id":27407705,"uuid":"30884554","full_name":"plouc/mozaik-ext-github","owner":"plouc","description":"Mozaïk github widgets","archived":false,"fork":false,"pushed_at":"2018-07-30T18:57:25.000Z","size":779,"stargazers_count":11,"open_issues_count":2,"forks_count":23,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-07T20:09:53.780Z","etag":null,"topics":["dashboard","dataviz","github","github-widget","mozaik"],"latest_commit_sha":null,"homepage":"http://mozaik-github.herokuapp.com/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/plouc.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-02-16T19:34:55.000Z","updated_at":"2022-12-21T10:32:29.000Z","dependencies_parsed_at":"2022-09-13T17:13:09.363Z","dependency_job_id":null,"html_url":"https://github.com/plouc/mozaik-ext-github","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plouc%2Fmozaik-ext-github","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plouc%2Fmozaik-ext-github/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plouc%2Fmozaik-ext-github/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plouc%2Fmozaik-ext-github/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/plouc","download_url":"https://codeload.github.com/plouc/mozaik-ext-github/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243894407,"owners_count":20365026,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dashboard","dataviz","github","github-widget","mozaik"],"created_at":"2024-10-08T08:07:29.605Z","updated_at":"2025-03-18T01:31:24.490Z","avatar_url":"https://github.com/plouc.png","language":"JavaScript","readme":"# Mozaïk GitHub widgets\n\n[![License][license-image]][license-url]\n[![Travis CI][travis-image]][travis-url]\n[![NPM version][npm-image]][npm-url]\n[![Dependencies][gemnasium-image]][gemnasium-url]\n[![Coverage Status][coverage-image]][coverage-url]\n![widget count][widget-count-image]\n\n[![Deploy][heroku-image]][heroku-url]\n\n\u003e This branch contains code for the version compatible with\n\u003e Mozaïk v2, if you're looking for v1, please use\n\u003e [mozaik-1 branch](https://github.com/plouc/mozaik-ext-github/tree/mozaik-1).\n\nThis repository contains some GitHub widgets to use with [Mozaïk](https://github.com/plouc/mozaik).\n\n## Demo\n\nYou can see a live demo of the widgets [here](http://mozaik-ext-github-v2.herokuapp.com/)\n\n## Widgets\n\n- [Badges](#badges)\n  - [`\u003cOrgBadge /\u003e`](#orgbadge)\n  - [`\u003cRepoBadge /\u003e`](#repobadge)\n  - [`\u003cUserBadge /\u003e`](#userbadge)\n- [Stats](#stats)  \n  - [`\u003cRepoCommitActivityHistogram /\u003e`](#repocommitactivityhistogram)\n  - [`\u003cRepoCommitActivityLine /\u003e`](#repocommitactivityline)\n  - [`\u003cRepoContributorsStats /\u003e`](#repocontributorsstats)\n- [Traffic](#traffic)  \n  - [`\u003cRepoTrafficClonesHistogram /\u003e`](#repotrafficcloneshistogram)\n  - [`\u003cRepoTrafficClonesLine /\u003e`](#repotrafficclonesline)\n  - [`\u003cRepoTrafficViewsHistogram /\u003e`](#repotrafficviewshistogram)\n  - [`\u003cRepoTrafficViewsLine /\u003e`](#repotrafficviewsline)\n- [`\u003cBranches /\u003e`](#branches)\n- [`\u003cPullRequests /\u003e`](#pullrequests)  \n- [`\u003cStatus /\u003e`](#status)\n\n\n## Github Client Configuration\n\nIn order to use the Mozaïk github widgets, you should configure its **client**.\nIt's not required that you provide a token for authentication, but then\nyou'll only be able to see public repos and the rate limit will apply.\n\n### parameters\n\nkey       | env key          | required | default                | description\n----------|------------------|----------|------------------------|----------------------------\n`token`   | GITHUB_API_TOKEN | no       | ''                     | *github authentication token*\n`baseUrl` | GITHUB_BASE_URL  | no       | https://api.github.com | *github api url* (useful for enterprise)\n\n### usage\n\n``` yaml\n# config.yml\napi:\n  github:\n    baseUrl: \"\"\n    token:   MY_GITHUB_TOKEN\n```\n\n## Widgets doc\n\n### Badges\n\n#### OrgBadge\n\n\u003e Show github organization badge.\n\n![github organization badge](https://raw.githubusercontent.com/plouc/mozaik-ext-github/master/preview/github.organization_badge.png)\n\n##### parameters\n\nkey     | required | description\n--------|----------|--------------------------\n`org`   | yes      | *github organization identifier*\n`title` | no       | *overrides default title if provided*\n\n##### usage\n\n``` yaml\n# config.yml\ndashboards:\n- # …\n  widgets:\n  - extension:    github\n    widget:       OrgBadge\n    organization: github\n    columns:      1\n    rows:         1\n    x:            0\n    y:            0\n```\n\n\n#### RepoBadge\n\n\u003e Show repository info.\n\n##### parameters\n\nkey          | required | description\n-------------|----------|---------------\n`repository` | yes      | *github repository*\n`title`      | no       | *overrides default title if provided*\n\n##### usage\n\n``` yaml\n# config.yml\ndashboards:\n- # …\n  widgets:\n  - extension:  github\n    widget:     RepoBadge\n    repository: plouc/mozaik\n    columns:    1\n    rows:       1\n    x:          0\n    y:          0\n```\n\n\n#### UserBadge\n\n\u003e Show github user badge.\n\n![github user badge](https://raw.githubusercontent.com/plouc/mozaik-ext-github/master/preview/github.user_badge.png)\n\n##### parameters\n\nkey     | required | description\n--------|----------|--------------------------\n`user`  | yes      | *github user identifier*\n`title` | no       | *overrides default title if provided*\n\n##### usage\n\n``` yaml\n# config.yml\ndashboards:\n- # …\n  widgets:\n  - extension: github\n    widget:    UserBadge\n    user:      plouc\n    columns:   1\n    rows:      1\n    x:         0\n    y:         0\n```\n\n\n### Stats\n\n#### RepoCommitActivityHistogram\n\n##### parameters\n\nkey          | required | description\n-------------|----------|---------------\n`repository` | yes      | *github repository*\n`title`      | no       | *overrides default title if provided*\n\n##### usage\n\n``` yaml\n# config.yml\ndashboards:\n- # …\n  widgets:\n  - extension:  github\n    widget:     RepoCommitActivityHistogram\n    repository: plouc/mozaik\n    columns:    2\n    rows:       1\n    x:          0\n    y:          0\n```\n\n\n#### RepoCommitActivityLine\n\n##### parameters\n\nkey          | required | description\n-------------|----------|---------------\n`repository` | yes      | *github repository*\n`title`      | no       | *overrides default title if provided*\n\n##### usage\n\n``` yaml\n# config.yml\ndashboards:\n- # …\n  widgets:\n  - extension:  github\n    widget:     RepoCommitActivityLine\n    repository: plouc/mozaik\n    columns:    2\n    rows:       1\n    x:          0\n    y:          0\n```\n\n\n#### RepoContributorsStats\n\n##### parameters\n\nkey          | required | description\n-------------|----------|---------------\n`repository` | yes      | *github repository*\n`title`      | no       | *overrides default title if provided*\n\n##### usage\n\n``` yaml\n# config.yml\ndashboards:\n- # …\n  widgets:\n  - extension:  github\n    widget:     RepoContributorsStats\n    repository: plouc/mozaik\n    columns:    2\n    rows:       1\n    x:          0\n    y:          0\n```\n\n\n### Traffic\n  \n#### RepoTrafficClonesHistogram\n\n##### parameters\n\nkey          | required | description\n-------------|----------|---------------\n`repository` | yes      | *github repository*\n`title`      | no       | *overrides default title if provided*\n\n##### usage\n\n``` yaml\n# config.yml\ndashboards:\n- # …\n  widgets:\n  - extension:  github\n    widget:     RepoTrafficClonesHistogram\n    repository: plouc/mozaik\n    columns:    2\n    rows:       1\n    x:          0\n    y:          0\n```\n\n\n#### RepoTrafficClonesLine\n\n##### parameters\n\nkey          | required | description\n-------------|----------|---------------\n`repository` | yes      | *github repository*\n`title`      | no       | *overrides default title if provided*\n\n##### usage\n\n``` yaml\n# config.yml\ndashboards:\n- # …\n  widgets:\n  - extension:  github\n    widget:     RepoTrafficClonesLine\n    repository: plouc/mozaik\n    columns:    2\n    rows:       1\n    x:          0\n    y:          0\n```\n\n\n#### RepoTrafficViewsHistogram\n\n##### parameters\n\nkey          | required | description\n-------------|----------|---------------\n`repository` | yes      | *github repository*\n`title`      | no       | *overrides default title if provided*\n\n##### usage\n\n``` yaml\n# config.yml\ndashboards:\n- # …\n  widgets:\n  - extension:  github\n    widget:     RepoTrafficViewsHistogram\n    repository: plouc/mozaik\n    columns:    2\n    rows:       1\n    x:          0\n    y:          0\n```\n\n\n#### RepoTrafficViewsLine\n\n##### parameters\n\nkey          | required | description\n-------------|----------|---------------\n`repository` | yes      | *github repository*\n`title`      | no       | *overrides default title if provided*\n\n##### usage\n\n``` yaml\n# config.yml\ndashboards:\n- # …\n  widgets:\n  - extension:  github\n    widget:     RepoTrafficViewsLine\n    repository: plouc/mozaik\n    columns:    2\n    rows:       1\n    x:          0\n    y:          0\n```\n\n\n### Branches\n\n\u003e Show github branches with authors.\n\n![github repository branches](https://raw.githubusercontent.com/plouc/mozaik-ext-github/master/preview/github.branches.png)\n\n#### parameters\n\nkey          | required | description\n-------------|----------|---------------\n`repository` | yes      | *github repository*\n`title`      | no       | *overrides default title if provided*\n\n#### usage\n\n``` yaml\n# config.yml\ndashboards:\n- # …\n  widgets:\n  - extension:  github\n    widget:     Branches\n    repository: plouc/mozaik\n    columns:    1\n    rows:       1\n    x:          0\n    y:          0\n```\n\n\n### PullRequests\n\n\u003e Show github repository pull requests with authors.\n\n#### parameters\n\nkey          | required | description\n-------------|----------|---------------\n`repository` | yes      | *github repository*\n`title`      | no       | *overrides default title if provided*\n\n#### usage\n\n``` yaml\n# config.yml\ndashboards:\n- # …\n  widgets:\n  - extension:  github\n    widget:     PullRequests\n    repository: plouc/mozaik\n    columns:    1\n    rows:       1\n    x:          0\n    y:          0\n```\n\n\n### Status\n\n\u003e Shows the latest Github system status information from [https://status.github.com/](https://status.github.com/)\n\n![Github Status](https://raw.githubusercontent.com/plouc/mozaik-ext-github/master/preview/github.status.png)\n\n#### usage\n\n``` yaml\n# config.yml\ndashboards:\n- # …\n  widgets:\n  - extension: github\n    widget:    Status\n    columns:   1\n    rows:      1\n    x:         0\n    y:         0\n```\n\n\n[license-image]: https://img.shields.io/github/license/plouc/mozaik-ext-github.svg?style=flat-square\n[license-url]: https://github.com/plouc/mozaik-ext-github/blob/master/LICENSE.md\n[travis-image]: https://img.shields.io/travis/plouc/mozaik-ext-github.svg?style=flat-square\n[travis-url]: https://travis-ci.org/plouc/mozaik-ext-github\n[npm-image]: https://img.shields.io/npm/v/mozaik-ext-github.svg?style=flat-square\n[npm-url]: https://www.npmjs.com/package/mozaik-ext-github\n[gemnasium-image]: https://img.shields.io/gemnasium/plouc/mozaik-ext-github.svg?style=flat-square\n[gemnasium-url]: https://gemnasium.com/plouc/mozaik-ext-github\n[coverage-image]: https://img.shields.io/coveralls/plouc/mozaik-ext-github.svg?style=flat-square\n[coverage-url]: https://coveralls.io/github/plouc/mozaik-ext-github\n[widget-count-image]: https://img.shields.io/badge/widgets-x13-green.svg?style=flat-square\n[heroku-image]: https://www.herokucdn.com/deploy/button.svg\n[heroku-url]: https://heroku.com/deploy?template=https://github.com/plouc/mozaik-ext-github/tree/demo","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplouc%2Fmozaik-ext-github","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplouc%2Fmozaik-ext-github","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplouc%2Fmozaik-ext-github/lists"}