UNPKG

xapi-statements/readme.md

Version:

1.88 kBMarkdownView Raw

1# xAPI Statements
2
3[![NPM Package Version](https://badge.fury.io/js/xapi-statements.svg)](https://www.npmjs.com/package/xapi-statements)
4[![Build Status](https://circleci.com/gh/LearningLocker/xapi-statements/tree/master.svg?style=shield)](https://circleci.com/gh/LearningLocker/xapi-statements)
5[![Renovate badge](https://img.shields.io/badge/Renovate-enabled-brightgreen.svg)](https://renovateapp.com/)
6[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
7[![Join the chat at https://gitter.im/LearningLocker/learninglocker](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/LearningLocker/learninglocker?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
8
9*Learning Locker is a trademark of [HT2 Inc.](http://ht2labs.com)*
10
11### Installation
12To install all of Learning Locker, see the [installation documentation](http://docs.learninglocker.net/guides-installing/). To install just the xAPI statements service, you can follow the instructions below.
13
141. Clone the repository `git clone git@github.com:LearningLocker/xapi-statements.git`.
151. Install dependencies `npm install`.
161. Build the code `npm run build`.
171. Start the server `npm start`.
18
19### Development
201. Follow [the installation procedure](#installation).
211. Make your changes to the "src" directory.
221. Build the code `npm run build`.
231. Test the code `npm run test-all`.
241. Run the server `npm start`.
25
26### Docker
27You can use the steps below to install and run the xAPI statements service.
28
29- Create a ".env" file using the ".env.example" file in this Github repository.
30- Pull the image from DockerHub `docker pull learninglocker/xapi-statements:master`.
31- Run the image in a container `docker run -d -p 8080:80 --env-file .env learninglocker/xapi-statements:master`.

1	`# xAPI Statements`
2
3	`[![NPM Package Version](https://badge.fury.io/js/xapi-statements.svg)](https://www.npmjs.com/package/xapi-statements)`
4	`[![Build Status](https://circleci.com/gh/LearningLocker/xapi-statements/tree/master.svg?style=shield)](https://circleci.com/gh/LearningLocker/xapi-statements)`
5	`[![Renovate badge](https://img.shields.io/badge/Renovate-enabled-brightgreen.svg)](https://renovateapp.com/)`
6	`[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)`
7	`[![Join the chat at https://gitter.im/LearningLocker/learninglocker](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/LearningLocker/learninglocker?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)`
8
9	`Learning Locker is a trademark of [HT2 Inc.](http://ht2labs.com)`
10
11	`### Installation`
12	`To install all of Learning Locker, see the [installation documentation](http://docs.learninglocker.net/guides-installing/). To install just the xAPI statements service, you can follow the instructions below.`
13
14	1. Clone the repository `git clone git@github.com:LearningLocker/xapi-statements.git`.
15	1. Install dependencies `npm install`.
16	1. Build the code `npm run build`.
17	1. Start the server `npm start`.
18
19	`### Development`
20	`1. Follow [the installation procedure](#installation).`
21	`1. Make your changes to the "src" directory.`
22	1. Build the code `npm run build`.
23	1. Test the code `npm run test-all`.
24	1. Run the server `npm start`.
25
26	`### Docker`
27	`You can use the steps below to install and run the xAPI statements service.`
28
29	`- Create a ".env" file using the ".env.example" file in this Github repository.`
30	- Pull the image from DockerHub `docker pull learninglocker/xapi-statements:master`.
31	- Run the image in a container `docker run -d -p 8080:80 --env-file .env learninglocker/xapi-statements:master`.