search

asterics / AsTeRICS-Ergo

AsTeRICS based edition for occupational therapy. It will contain parametrizable models for environmental control, game accessibility and other use cases with easy configurator user interfaces.
Other
4 stars 0 forks source link
accessibility assistive-technology asterics-main environmental-control

readme

AsTeRICS Models for occupational therapy

Also see the AsTeRICS Ergo Info page

This is an AsTeRICS based edition for occupational therapy. It will contain parametrizable models for environmental control, game accessibility and other use cases with easy configurator user interfaces.

The model files are located in custom/bin/ARE/models. The document root of the embedded webserver is located at custom/bin/ARE/data/webservice

Install and build instructions of prerequisites

AsTeRICS-Ergo is based on the master branch of AsTeRICS.

  1. Clone the AsTeRICS repository including submodules 
    git clone --recurse-submodules https://github.com/asterics/AsTeRICS.git
  2. Install the Java Development Kit 8 (32-bit)
    • Verify the java installation by opening a command shell and entering javac -version. In case of trouble, ensure to set JAVA_HOME to the folder where you installed the Java JDK and add the JDK bin path to the Environment Variable PATH
  3. Install the apache ant build framework (version >= 1.9.1)
    • Ensure to set ANT_HOME to the folder where you installed ant and add the ant bin path to the Environment Variable Path
  4. Clone AsTeRICS-Ergo repository to parallel folder 
    git clone https://github.com/asterics/AsTeRICS-Ergo.git

Run project

  1. Start the project by opening a terminal window in the root folder of the AsTeRICS-Ergo repository (or use Eclipse with ant support) and call ant run
  2. Open application's webpage at http://localhost:8081

Recommended workflow for development

  1. Save custom files (models, images, config files,...) to the custom/bin/ARE folder or modify them
  2. Call ant run
  3. Kill program and go to step 1

Create installer

You can use APE to create native installers for AsTeRICS Ergo.

Prerequisites

Install installer-specific toolkits like

depending on the required target platform. You must run the installer build process on the target platform of the installer. For more details, read the JavaFX packaging tutorial

Installer creation

ant deploy

License

Licensed under a dual license MIT or GPL with CLASSPATH exception

How to apply the dual licensing

You may use these components under the terms of the MIT License, if no source code (plugins, services, libraries, ...) which is contained in your desired collection of ARE plugins and services is licensed under the GNU General Public License (GPL). In order for that, you can remove unneeded plugins or services.

Please have a look at the individual licenses of the AsTeRICS plugins and services. You find the license files in the subfolder LICENSE of every plugin.

Disclaimer

This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software. See DISCLAIMER