raphy/epitech-api

An easy and modular API to request information from the Epitech's intranet

v2.0.3 2015-10-21 17:40 UTC

README

This repository is abandoned and the project is rewritten at raphy/epitech-intranet

An easy to use and modular API to request information from Epitech's intranet.

Requirements

The EpitechAPI library has the following requirements:

Installation

The library is available on Packagist here. Install it via Composer:

composer require raphy/epitech-api

Documentation

The main documentation can be found at the doc directory in this repository. You can read by starting at the documentation main page

The API documentation is built with Sami and hosted on GitHub Pages. It is available here.

Generate the API documentation by running the command:

composer sami

Modularity

Since the components use the EpitechAPI\Connector class, the components can be diversified! You can contribute and share your own components for a better EpitechAPI!

Unit Tests

The repository is tested by Travis-CI. See the build status here.

The unit tests are made with PHPUnit. To launch the unit tests, run:

composer phpunit