Skip to content

Latest commit

 

History

History
87 lines (61 loc) · 4.01 KB

README.md

File metadata and controls

87 lines (61 loc) · 4.01 KB

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.

Build Status Dependency Status

Installation

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

First, install Node.js if you haven't yet. npm is the package manager for Node.js and comes bundled with it.

Install Webpack:

$> sudo npm install webpack -g

Clone the repository:

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

If you're interested in latest changes or want to contribute to the project, switch to the dev branch:

$> git checkout dev
$> git pull

Now, lets install all the dependencies:

$> npm install

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

Start the development server and see the application running at localhost:8080:

$> npm run serve

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 Webpack Node.js

Dependencies

Bootstrap jQuery AngularJS with AngularUI D3.js Handsontable with ngHandsontable jStat Wrangler

Copyright and License

The LGPL v3.0 License

Copyright (c) 2013-2016 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.