SOCRAT: SOCR Analytics Toolbox

A scalable and highly flexible HTML5/JS platform to build and run in-browser applications for interactive data analysis and visualization.

• Web site: http://socr.umich.edu
• Issue-tracking and project management: https://socredu.atlassian.net/browse/SOCRFW

Installation

In case you wish to create your own module or contribute to the project, follow these steps to setup your enviroment.

First, install nodejs if you havent. npm is the package manager for Node.js and comes bundled with it.

Install Bower and Grunt,

$> npm install -g bower grunt-cli
$> npm update -b bower

Clone the repository.

$> git clone https://github.com/SOCR/SOCRAT.git 

Now, lets install all the dependencies. Go into the root folder, $> cd SOCRAT $> npm install $> bower install

This will install all the dependencies mentioned in package.json and bower.json files.

Start the server! See the application running at localhost:9000!

$> grunt serve

To start unit-test use. Status information will appear in the new browser window. Test runner will log into console.

$> grunt test

Motivation

SOCR, Statistics Online Computational Resource has a huge user base who constantly access the educational data present and java tools which use these data to aid in understanding statistics. As far as the technology is concerned, currently all the applications are written in java and are presented as java applets. The reach of these applications is bottlenecked by technology.

Goal

The world is going the HTML5 way. Browsers are becoming more powerful. We intend to create a toolbox which will serve users on all platforms. We are primarily using CoffeeScript (compiles to JavaScript) for all the computations and presentation. Given the fact that today’s browsers have powerful javaScript engines (v8, SpiderMonkey), we perform all the calculations on the browser with no server dependency. File management, database, computation will be performed inside the browser.

Technologies/Packages

CoffeeScript Jade Less Grunt Node.js

Dependencies

Bootstrap jQuery AngularJS D3.js Handsontable jStat Wrangler

Copyright and License

The LGPL v3.0 License

Copyright (c) 2013-2015 Statistics Online Computational Resource (SOCR)

All SOCR programs, materials, tools and resources are developed by and freely disseminated to the entire community. Users may revise, extend, redistribute, modify under the terms of the Lesser GNU General Public License as published by the Open Source Initiative. All efforts should be made to develop and distribute factually correct, useful, portable and extensible resource all available in all digital formats for free over the Internet.

SOCR resources are distributed in the hope that they will be useful, but without any warranty; without any explicit, implicit or implied warranty for merchantability or fitness for a particular purpose. See the GNU Lesser General Public License for more details see http://opensource.org/licenses/LGPL-3.0.