Skip to content
This repository has been archived by the owner on Nov 20, 2018. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@pauliejes
pauliejes committed Jun 2, 2016
1 parent 46daee2 commit 49df22d
Showing 1 changed file with 55 additions and 46 deletions.
101 changes: 55 additions & 46 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,30 +1,35 @@
Experience API Client Examples
=============================

### Start a static webserver to access to examples
```javascript
npm install
// after run command below you can access to examples with specific port
// 0.95 - http://localhost:9000
grunt connect:v095:keepalive
// 1.0 - http://localhost:9001
grunt connect:v100:keepalive
```

### *version*/original_prototypes/
Prototypes created for the original BAA effort, includes a Statement viewer,
Reporting example, and Tetris game example.

NOTE: The index page (index.html) references JQuery from Google CDN. Hard coding the scheme to 'http' caused issues when hosting these examples on a server configured for https. The scheme was removed from this url, which allows for the scheme to be decided dynamically. However this causes an issue when the prototypes are not hosted. In this case the prepended scheme is 'file' and prevents JQuery from loading. If you plan to run these example from in an unhosted environment, add the scheme to this url.
### 0.95/
Contains examples based on the 0.95 version of the Experience API Specification

```javascript
// change this line in <version>/original_prototypes/index.html
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.6.2/jquery.min.js"></script>
// to the following if running the examples unhosted (not on a server)
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.6.2/jquery.min.js"></script>
```
### 1.0/
Contains examples based on the 1.0 version of the Experience API Specification

Each folder contains three examples, a Report Sample, Statement Viewer, and JavaScript Tetris.

## Report Sample

The Statements tab displays all of the statements in the LRS in a human-readable form (I did this.). When each statement is clicked, it is expanded to show the full JSON representation of the statement that is stored inside of the LRS.

The Tetris Reporting tab contains a high score chart of the tetris scores from the JavaScript Tetris example, as well as a bar graph and scatter plot on how many times it took each user to achieve their high score.

## Statement Viewer

The Statement Viewer also displays all of the statements in the LRS in a collapsable human-readable format. This time however, you can query the statements based on the actor's email, verb ID, activity ID, since, until, registration, and actor JSON parameters. When the query is made, the full query is also visible.

## JS Tetris

The tetris game is a fully playable tetris game that sends playing statements to the LRS. It will send statements once you begin a game, complete a level, and when you inevitably lose. If you don't want to submit data to the LRS, you can uncheck the box below the game, and you can also change the actors name by giving it your name and email address. There is also another tetris leaderboard on the left side of the game.

## Oauth1

Path: /oauth/oauth1/

### /oauth/oauth1/
Contains 3-legged examples using [OAuth 1.0a](https://tools.ietf.org/html/rfc5849) to connect to the ADL LRS. Contains an
'out of band' example and redirect example. Be sure for both to add your client credentials for an OAuth1 client created
under your account on the LRS. The scope is also adjustable for both. (For the redirect example, make sure memcached has been started on your machine)
Expand All @@ -35,7 +40,10 @@ or

`python uri_redirect_example.py`

### /oauth/oauth2/
## Oauth2

Path: /oauth/oauth2/

Contains 3-legged example using [OAuth 2.0](https://tools.ietf.org/html/rfc6749) to connect to the ADL LRS. To run:

`python oauth2_example.py`
Expand All @@ -45,7 +53,16 @@ example since the LRS Oauth2 module only supports callback URLs.

*NOTE: For all OAuth examples, you'll need to install the python libs in each respective requirements.txt file.*

## config.js
## Contributing to the project
We welcome contributions to this project. Fork this repository,
make changes and submit pull requests. If you're not comfortable
with editing the code, please submit an issue and we'll be happy
to address it.

The xAPI client examples are built from the original Tin Can examples from Rustici Software that now implement ADL's [xAPIWrapper](https://github.com/adlnet/xAPIWrapper).
The examples are split into two folders, .95 for data compliant to the .95 xAPI specification and 1.0 for data compliant to the current 1.0.1 spec. Read more about the Experience API Spec [here](https://github.com/adlnet/xAPI-Spec/blob/master/xAPI.md).

## Configuration
The 0.95 and 1.0 folders each contain a config.js.template. It is used to configure the LRS endpoint and user information. To use, rename the file to just config.js.

example:
Expand All @@ -56,36 +73,28 @@ Config.password = "password";
Config.actor = { "mbox": "name@example.com", "name": "my name" };
```

Each folder contains three examples, a Report Sample, Statement Viewer, and JavaScript Tetris.

## Report Sample

The Statements tab displays all of the statements in the LRS in a human-readable form (I did this.). When each statement is clicked, it is expanded to show the full JSON representation of the statement that is stored inside of the LRS.

The Tetris Reporting tab contains a high score chart of the tetris scores from the JavaScript Tetris example, as well as a bar graph and scatter plot on how many times it took each user to achieve their high score.

## Statement Viewer

The Statement Viewer also displays all of the statements in the LRS in a collapsable human-readable format. This time however, you can query the statements based on the actor's email, verb ID, activity ID, since, until, registration, and actor JSON parameters. When the query is made, the full query is also visible.

## JS Tetris
NOTE: The index page (index.html) references JQuery from Google CDN. Hard coding the scheme to 'http' caused issues when hosting these examples on a server configured for https. The scheme was removed from this url, which allows for the scheme to be decided dynamically. However this causes an issue when the prototypes are not hosted. In this case the prepended scheme is 'file' and prevents JQuery from loading. If you plan to run these example from in an unhosted environment, add the scheme to this url.

The tetris game is a fully playable tetris game that sends playing statements to the LRS. It will send statements once you begin a game, complete a level, and when you inevitably lose. If you don't want to submit data to the LRS, you can uncheck the box below the game, and you can also change the actors name by giving it your name and email address. There is also another tetris leaderboard on the left side of the game.
```javascript
// change this line in <version>/original_prototypes/index.html
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.6.2/jquery.min.js"></script>
// to the following if running the examples unhosted (not on a server)
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.6.2/jquery.min.js"></script>
```

### 0.95/
Contains examples based on the 0.95 version of the Experience API Specification

### 1.0/
Contains examples based on the 1.0 version of the Experience API Specification
## Use

## Contributing to the project
We welcome contributions to this project. Fork this repository,
make changes and submit pull requests. If you're not comfortable
with editing the code, please submit an issue and we'll be happy
to address it.
### Start a static webserver to access to examples
```javascript
npm install
// after run command below you can access to examples with specific port
// 0.95 - http://localhost:9000
grunt connect:v095:keepalive
// 1.0 - http://localhost:9001
grunt connect:v100:keepalive
```

The xAPI client examples are built from the original Tin Can examples from Rustici Software that now implement ADL's [xAPIWrapper](https://github.com/adlnet/xAPIWrapper).
The examples are split into two folders, .95 for data compliant to the .95 xAPI specification and 1.0 for data compliant to the current 1.0.1 spec. Read more about the Experience API Spec [here](https://github.com/adlnet/xAPI-Spec/blob/master/xAPI.md).

## License
Copyright &copy;2016 Advanced Distributed Learning
Expand Down

0 comments on commit 49df22d

Please sign in to comment.