Code Monkey home page Code Monkey logo

st3k101's Introduction

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.