Skip to content

Commit 2cb4230

Browse files
committed
docs(readme): Updates the readme to match other readmes.
1 parent a8dd978 commit 2cb4230

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

readme.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,32 @@
11
# xAPI service
2-
> A server for xAPI
3-
2+
[![NPM Package Version](https://badge.fury.io/js/xapi-service.svg)](https://www.npmjs.com/package/xapi-service)
43
[![Build Status](https://travis-ci.org/LearningLocker/xapi-service.svg?branch=master)](https://travis-ci.org/LearningLocker/xapi-service)
4+
[![Greenkeeper badge](https://badges.greenkeeper.io/LearningLocker/xapi-service.svg)](https://greenkeeper.io/)
5+
[![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)
6+
[![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)
7+
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](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`.
526

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.
729

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

Comments
 (0)