/isle-editor

Editor for ISLE (Integrated Statistics Learning Environment) lessons.

Primary LanguageJavaScriptOtherNOASSERTION

ISLE Editor LICENSE

ISLE logo

Tests

Actions Status Coverage

Introduction

A desktop-application that can be used to author and preview integrated statistics learning environment (ISLE) lessons before they are deployed online. Other parts of the ISLE environment are:

  • the isle-server is the server program responsible for user management and data storage
  • the isle-dashboard is the online dashboard used to deploy, organize and monitor ISLE lessons

Open Documentation

Installation

Binaries

Current version: v0.76.11.

Download the isle-editor for Windows (.exe)

Download the isle-editor for macOS (.dmg)

Download the isle-editor for Linux (.AppImage) (alternative: .deb)

Build from Source

Prerequisites

Developing and running the ISLE Editor has the following prerequisites:

  • git: version control
  • Node.js: JavaScript runtime (version >= 14.0)
  • node-gyp: Node.js native addon build tool (see link for how to install pre-requisites on the various operating systems)

Download

To acquire the source code, clone the git repository.

$ git clone https://github.com/isle-project/isle-editor

To reduce the significant download time when cloning the repository, which is due to the large commit history of the project, you may limit the clone depth as follows:

$ git clone --depth=<depth> https://github.com/isle-project/isle-editor

where <depth> refers to the number of commits that should be retrieved (smallest acceptable value is 1).

Installation

To install development dependencies,

$ npm install

Build

To build and package the Electron application,

$ npm run build

The bundled version can be started with

$ npm start

Development

To live-edit the ISLE Editor,

$ npm run dev

Editing source files will result in changes appearing directly without reloading.

Package

To package the editor as a standalone application for the current operating system, run

$ npm run package

To bundle for all operating systems, run

$ npm run package-all

Tests

The ISLE editor uses Jest for unit tests. To run the tests, execute the following command in the top-level application directory:

$ npm test

To only run the tests for a single component or function, use

$ npm run test -- -t "name-of-spec"

License

See LICENSE.

Icon Credits

The following icons are used under a Creative Commons CCBY license.

  • "Confused" by Greg Pabst
  • "Lightbulb" by Jeremy J Bristol
  • "Microphone" by Aleksandr Vector
  • "Positive Feedback Loop" by Richard Slater
  • "bar chart" by Barracuda
  • "Scatterplot" by JeraOcean
  • "K-Means" by Knut M. Synstad from the Noun Project
  • "SVM", "k nearest Neighbours", "Classification tree graph", "Naive Bayes", "Random Forest", "Neural Networks" by sachin modgekar from the Noun Project
  • "logistic regressions" by Christina Barysheva from the Noun Project
  • "Lasso" by Sam Neckles from the Noun Project
  • "net" by Lisa Oregioni from the Noun Project
  • "detail roof shed ridge" by kloeg architecture from the Noun Project
  • "linear regression" by Knut M. Synstad from the Noun Project
  • "dimension" by Andreav from the Noun Project
  • "bag" by Andrejs Kirma from the Noun Project
  • "boost" by Yo! Baba from the Noun Project