@sointeractive/angry-jupiter NPM

AngryJupiter

AngryJupiter is a console tool kit based on Node.js which allows for managing gamification instances in IsaaCloud.

The tools make it possible to:

send initial configuration to an instance
generate .zip archives with transaction data.

AngryJupiter has a modular structure. This repository contains the Core of the application, on the basis of which individual modules are installed. No module can operate on its own without the Core installed.

Installation

To install AngryJupiter Core, run the following command:

(sudo) npm install -g @sointeractive/angry-jupiter

Don't panic when you see a furious planet in your console - it's a normal state of being. :)

Once Core installation is finished, you are ready to install the modules.

Modules

Setup

Setup allows for sending an initial configuration for a gamification instance in IsaaCloud. Configuration may contain such elements as: achievements, scripts, leaderboards, and tags.

To learn more, see AngryJupiter Setup on GitHub

Importer

Importer creates a .zip file containing 4 .cvs files (MEMBERS.csv, TRANSACTIONS.csv, AIR_TRANSACTIONS.csv and TRANSACTION_REWARDS.csv). The files are created on the basis of templates containing a transation scenario that is repeated on any number of users.

To learn more, see AngryJupiter Importer on GitHub

Usage

Module installation (not working from version 2.0.3 - see changelog)

To install one or more AngryJupiter modules, run the following command in your console:

angry [options] install  <modules...>

where:

<modules...> is a required parameter that specifies one or more AngryJupiter module names to be installed
[options] are optional (see below)

Running modules

To run an AngryJupiter module, run the following command in your console:

angry [options] <moduleName> [commands...]

where:

<moduleName> is a required parameter
[options] are optional (see below)
[commands...] is an optional parameter which refers to one or more module-specific commands (see documentation on individual modules for more details)

Options

You can run the application with the following options:

Option	Description
`-h`, `--help`	outputs information on how to use the application
`-V`, `--version`	outputs the version of the application
`-d`, `--details`	runs the application in the details mode