An open API service indexing awesome lists of open source software.

https://github.com/learninglocker/statementfactory

Learning Locker's classes for xAPI.
https://github.com/learninglocker/statementfactory

Last synced: 7 months ago
JSON representation

Learning Locker's classes for xAPI.

Awesome Lists containing this project

README

          

# xAPI
> Learning Locker's classes for xAPI.

[![Build Status](https://travis-ci.org/learninglocker/statementfactory.svg)](https://travis-ci.org/learninglocker/statementfactory)
[![Latest Stable Version](https://poser.pugx.org/learninglocker/statementfactory/v/stable.svg)](https://packagist.org/packages/learninglocker/statementfactory)
[![Total Downloads](https://poser.pugx.org/learninglocker/statementfactory/downloads.svg)](https://packagist.org/packages/learninglocker/statementfactory)
[![License](https://poser.pugx.org/learninglocker/statementfactory/license.svg)](https://packagist.org/packages/learninglocker/statementfactory)
[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/LearningLocker/learninglocker?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

If you have a bug, enhancement, or question you can post it in the [issues](/issues), however, please see the [guidelines](/contributing.md) before doing so. You may also ask questions and chat on [Gitter](https://gitter.im/LearningLocker/learninglocker).

## Users
Documentation can be found in the [docs](/docs) directory. Install using `composer require learninglocker/statementfactory`.

## Developers
You may contribute to this project via [issues](/issues) and [pull request](/pulls), however, please see the [guidelines](/contributing.md) before doing so.

### Getting Started
1. [Fork](/fork) the repository.
2. Clone your forked version of the repository.
3. Run `composer install`.
4. Change the code.
5. Commit and push your changes to Github.
6. Repeat from Step 4 or continue to step 7.
7. Create a [pull request](/pulls) on Github (ensuring that you follow the [guidelines](/contributing.md)).

### Directory Structure
- [src](/src) - Source code written in PHP.
- [tests](/tests) - Testing code written in PHP.
- [docs](/docs) - Documentation written in "Github Flavoured Markdown".

### Testing
You should try to ensure that `./vendor/bin/phpunit tests` runs without any errors before submitting a pull request.