Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/rusticisoftware/tincanjava

Tin Can Java Library
https://github.com/rusticisoftware/tincanjava

java java-library tincan xapi

Last synced: 26 days ago
JSON representation

Tin Can Java Library

Awesome Lists containing this project

README

        

A Java library for implementing the xAPI.

For hosted API documentation, basic usage instructions, supported version listing, etc. visit the main project website at:

http://rusticisoftware.github.io/TinCanJava/

For more information about the Experience API (xAPI) visit:

http://xapi.com/

This library uses Maven 3 for project management, building, etc. It outputs Maven artifacts.

Building
--------

Check out the source:

git clone https://github.com/RusticiSoftware/TinCanJava.git
cd TinCanJava

With the repo cloned copy the `src/test/resources/lrs.properties.template` file
to `src/test/resources/lrs.properties` and adjust the values to point to a valid LRS. Then
build the project using:

mvn install

This will download dependencies (that are not already locally available) and build and test the
artifact. The result will be in `target/tincan-0.2.5-SNAPSHOT.jar`. To build a specific version
of the library you will need to checkout to the tag for that version first, such as:

git checkout tincan-0.2.4

And then do `mvn install`, which will provide `target/tincan-0.2.4.jar`.

Releasing
---------

See http://maven.apache.org/maven-release/maven-release-plugin/index.html.

mvn release:prepare -DdryRun=true
mvn release:clean
mvn release:prepare
mvn release:perform

At some point in the future we plan to make the maven artifacts available via some publicly
available repository.