|
1 | 1 | # xAPI service |
2 | | -> A server for xAPI |
3 | | -
|
| 2 | +[](https://www.npmjs.com/package/xapi-service) |
4 | 3 | [](https://travis-ci.org/LearningLocker/xapi-service) |
| 4 | +[](https://greenkeeper.io/) |
| 5 | +[](https://github.com/semantic-release/semantic-release) |
| 6 | +[](https://gitter.im/LearningLocker/learninglocker?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
| 7 | +[](http://commitizen.github.io/cz-cli/) |
| 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 service, you can follow the instructions below. |
| 13 | + |
| 14 | +1. Clone the repository `git clone [email protected]:LearningLocker/xapi-service.git`. |
| 15 | +1. Install dependencies `npm install`. |
| 16 | +1. Build the code `npm run build`. |
| 17 | +1. Run migrations `npm run migrate`. |
| 18 | +1. Start the server `npm start`. |
| 19 | + |
| 20 | +### Development |
| 21 | +1. Follow [the installation procedure](#installation). |
| 22 | +1. Make your changes to the "src" directory. |
| 23 | +1. Build the code `npm run build`. |
| 24 | +1. Test the code `npm run test-all`. |
| 25 | +1. Run the server `npm start`. |
5 | 26 |
|
6 | | -*Learning Locker is copyright [HT2](http://ht2.co.uk)* |
| 27 | +### Docker |
| 28 | +You can use the steps below to install and run the xAPI service. |
7 | 29 |
|
8 | | -Please see our [documentation](http://docs.learninglocker.net) for installation, configuration, and usage instructions. |
| 30 | +- Create a ".env" file using the ".env.example" file in this Github repository. |
| 31 | +- Pull the image from DockerHub `docker pull learninglocker/xapi-service:master`. |
| 32 | +- Run the image in a container `docker run -d -p 8080:80 --name xus --env-file .env learninglocker/xapi-service:master`. |
0 commit comments