mylk / bamboohr-leaves-notifier

A notifier for BambooHR leaves

bamboohr-leaves-notifier

Running this command will allow you to utilize webhooks for the leaves functionality of BambooHR.

Usage

Prerequisites

PHP 7 is required for bamboohr-leaves-notifier to run.

Installing

Clone this project:

git clone https://github.com/mylk/bamboohr-leaves-notifier

Install the dependencies:

composer install

Run

To execute bamboohr-leaves-notifier and get some help:

cd bamboohr-leaves-notifier
bamboohrleaves list

Copy config/parameters.example.yaml to config/parameters.yaml and modify it to your BambooHR API settings. Also copyconfig/config.example.yaml to config/config.yaml and configure it to meet your team and notification needs.

To poll for changes on leaves:

bamboohrleaves poll

Contributing

bamboohr-leaves-notifier is open source and of course you can contribute. Just fork the project, have fun and then create a pull request.

A Makefile has been created to group some tasks needed for development. Find those tasks below.

Running the tests

make tests

Syntax checks

make check-syntax

Coding style checks

The coding style that is followed is PSR-2.

make check-style

Quality checks

make check-quality

Built With

• symfony/console - The library used for the command line interface
• symfony/yaml - The library used to read the YAML configuration of the application
• symfony/dependency-injection - The library that instantiates the services used in the project
• doctrine/orm - An object relational mapper (ORM)

Versioning

SemVer is used for versioning. For the versions available, see the tags.

Authors

See the list of contributors.

License

This project is licensed under the GPLv2 License - see the LICENSE file for details.