Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 1.45 KB

README.md

File metadata and controls

48 lines (32 loc) · 1.45 KB

GithubApiBundle Build Status

A Kimai 2 plugin, which allows to use github-api to connecto to github or similar.

Installation

First clone it to your Kimai installation plugins directory:

cd /kimai/var/plugins/
git clone https://github.com/Bjoern3003/github-api-bundle.git

And then rebuild the cache:

cd /kimai/
bin/console cache:clear
bin/console cache:warmup

You could also download it as zip and upload the directory via FTP:

/kimai/var/plugins/
├── GithubApiBundle
│   ├── GithubApiBundle.php
|   └ ... more files and directories follow here ...

Configuration

Now you are able to configure your Github Client in your Kimai Systemconfig Backend.

But you aren't required to configure this Bundle. It will also work with the defaults (Only connect to public repositorys).

Usage

You can use your Client for example in Controller Files.

Declare your Instance with GithubClient $client in your method.

And then you can call your repositorys for example with: $client->api('user')->myRepositories(); Please refer this docummentation for for informations: https://github.com/KnpLabs/php-github-api

License

See LICENSE.txt. Don't worry, it's the MIT license.