Skip to content
📄 Open edX xAPI plugin
Dockerfile Makefile Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docker/config/lms
xapi
.dockerignore
.env
.gitignore
Dockerfile
LICENSE
Makefile
README.md
docker-compose.yml
requirements.txt
setup.cfg
setup.py

README.md

Open edX xAPI plugin

Specification

This repository is a work in progress for the integration of xAPI in the Open edx platform. For reference, please read: Open edX Proposal - 0026.

Getting started

First things first, if you plan to work on the project itself, you will need to clone this repository:

$ git clone git@github.com:openfun/openedx-xapi.git

Once the project has been cloned on your machine, you will need to build a custom edx-platform docker image that includes the xapi Django application and setup a development environment that includes all required services up and running (more on this later):

$ cd openedx-xapi
$ make bootstrap

If everything went well, you should now be able to access to the following services:

with the following credentials:

email: admin@foex.edu
password: openedx-rox

Developer guide

Once the project has been bootstrapped (see "Getting started" section), to start working on the project, use:

$ make dev

You can stop running services via:

$ make stop

If for any reason, you need to drop databases and start with fresh ones, use the down target:

$ make down

License

The code in this repository is licensed under the AGPL-3.0 unless otherwise noted (see LICENSE for details).

You can’t perform that action at this time.