@learninglocker/xapi-statements

A service for xAPI statements

Stats

StarsIssuesVersionUpdatedCreatedSize
@learninglocker/xapi-statements
7.8.02 years ago4 years agoMinified + gzip package size for @learninglocker/xapi-statements in KB

Readme

xAPI Statements

Build Status Renovate badge semantic-release Join the chat at https://gitter.im/LearningLocker/learninglocker

Learning Locker is a trademark of HT2 Inc.

Installation

To install all of Learning Locker, see the installation documentation. To install just the xAPI statements service, you can follow the instructions below.

  1. Clone the repository git clone git@github.com:LearningLocker/xapi-statements.git.
  2. Install dependencies npm install.
  3. Build the code npm run build.
  4. Start the server npm start.

Development

  1. Follow the installation procedure.
  2. Make your changes to the "src" directory.
  3. Build the code npm run build.
  4. Test the code npm run test-all.
  5. Run the server npm start.

Docker

You can use the steps below to install and run the xAPI statements service.

  • Create a ".env" file using the ".env.example" file in this Github repository.
  • Pull the image from DockerHub docker pull learninglocker/xapi-statements:master.
  • Run the image in a container docker run -d -p 8080:80 --env-file .env learninglocker/xapi-statements:master.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.