tst5381 / jseditor

ARIS Web Editor

A browser based javascript editor for the ARIS games platform. Built on top of the Backbone.Marionette MVC framework. See http://arisgames.org

Requirements

Library	Version	Install
less	2.5.1	npm install -g less
require.js	2.1.10	npm install -g requirejs
jquery	1.10.2
marionette	1.4.1
backbone	1.1.0
underscore	1.5.2

Getting Started

The flow control of the application goes:

• index.html Load require.js and load main.
• scripts/main.js Defines short cuts to frameworks, sets up dependencies, triggers application.
• scripts/application.js Sets up regions and event handlers for them, checks for authentication and fires up the router.
• scripts/models/session.js Manages session cookie and authentication.
• scripts/router.js Maps starting point urls (the application does not map 1 to 1 for urls and views) to functions, loads models and renders their views.

Installation

Copy scripts/config.js.template to scripts/config.js and modify to your server preferences.

Run make build which will compile css, run the r.js optimizer to unify all modules, and build index.html from index.html.template and the above config file.

Building requires:

• Make
• Bash
• LessCSS
• Require.js (R.js optimizer tool)
• sha256sum (Installed on OSX/Linux by default)

Install these however you wish. For development you can install node.js and then npm install from the project folder. Then add ./node_modules/.bin to your path.

Notes

All Aris API is backed by Backbone models located in the scripts/models/ directory.

A custom Backbone.sync method replaces the normal REST style of communication with one friendly to the Aris Amfphp Json backend.

Translations

Text sourced by running xgettext.pl (BSD version on OSX) to get .po files of templates. Edited with poedit or similar. Then po2json from https://github.com/mikeedwards/po2json converts them to json with jed mode enabled.

---

This project is licensed under the terms of the MIT license.