/st3k101

UNMAINTAINED.

Primary LanguagePython

xAPI-Probe

CircleCI Greenkeeper badge

Frontend Coverage: codecov

What is this?

The xAPI-Probe (codename st3k101) is a survey tool targeting applications in the social sciences. It uses xAPI for data exchange and has a RESTful API.

The tool is realized as a full-stack web application, featuring a reactive frontend written in VueJS. It was originally developed as part of a seminar work by @yeldiRium and @strangedev, but has since been heavily modified. The survey tool backend was the topic of @strangedev's bachelor thesis, which can be found here.

Project Structure

The project is divided into different services, which can be found in the identically named directories:

  • frontend
  • backend
  • xapi-publisher

Each of these services provides their own README, outlining the most important information about the service, as well as information on how to set up a development environment for working on the service.

Deployment

Requirements

  • docker >=18.06
  • docker-compose >=1.22

Deployment can be done following three simple steps:

  1. Download the docker-compose.prod.yml file.
  2. Download and modify the backend.env file.
  3. Run docker-compose up -d 😄.

For a guide on how to modify the backend.env file, see the backend service's README.