Skip to content

A OctoberCMS plugin which utilizes to GitHub API to show informations about repositories.

License

Notifications You must be signed in to change notification settings

r111346/octobercms-github-projects

 
 

Repository files navigation

OctoberCMS GitHub Projects Plugin

Software License Build Status HHVM StyleCI Quality Score Code Coverage

A plugin which utilizes to GitHub API to show informations about repositories.


Details

This plugin will provide a collection of components to display data about GitHub repositories based on the GitHub API v3.

As time passes more parts like Projects or Issues will be added to this collection of components.

Requirements

In order to work the PHP cURL extension must be installed and enabled.


Documentation

RepoList

List public repositories for the specified user.

Parameters

Name Type Description
user string The user whose repositories are displayed
type string The repository type. Can be one of all, owner, member. Default: owner
sort string The sorting field. Can be one of created, updated, pushed, full_name. Default: full_name
direction string The sort direction. Can be one of asc or desc. Default: when using full_name: asc, otherwise desc

Item

Get a specific repository

The available variables which can be used in the component view are listed here: https://developer.github.com/v3/repos/#response-3

Parameters

Name Type Description
user string The user whose repository is displayed
repo string The repository name

Gist

Get a specific repository

The available variables which can be used in the component view are listed here: https://developer.github.com/v3/gists/#get-a-single-gist

Parameters

Name Type Description
id string ID of the gist
sha string Get a specific revision of a gist

Contributing

Please submit pull requests with translations or bugfixes on the plugin's GitHub page. Bug reports and feature requests via Issues are welcome!

Security

If you discover any security related issues, please email it on [email protected] instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

About

A OctoberCMS plugin which utilizes to GitHub API to show informations about repositories.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 92.7%
  • HTML 7.2%
  • JavaScript 0.1%