Skip to content

RRothfeld/CrossCompare-js

Repository files navigation

CrossCompare.js

CrossCompare is a JavaScript library for quickly comparing charts built using dc.js. Bundled with crossfilter, dc.js provides fantastic in-browser dimenional filtering and charting. CrossCompare now adds the ability to quickly compare different filter states in a separate chart.

CrossCompare started as a Master of Science project for Software Development at the University of Glasgow. This project is meant to evaluate the marketablility of open-source, web-based dashboard tools and seeks to advance its status quo.

Please feel free to utilise, explore, enhance, or give feedback. Special thank's to the authors of jQuery, d3.js, crossfilter, dc.js, c3.js, AdminLTE, bootstrap, smoothscroll, and popup overlay!

CrossCompare Usage

Download the crosscompare zip-file and extract it into your web page folder. Include the JavaScript-file within your webpage. Set up and customize CrossCompare for your usage according to the API or the tutorial - a great starting place for a new CrossCompare application.

Installation (replica web site)

This repository holds all code for the web site shown under: http://rrothfeld.github.io/CrossCompare-js/.

  1. Have Node.js and git installed
  2. Clone this repository: git clone https://github.com/RRothfeld/CrossCompare-js.git
  3. Cd into the created folder: cd CrossCompare-js
  4. Install node modules: npm install
  5. Run the application: npm start
  6. Open http://localhost:3000/ in your web browser

A possible error upon executing npm start may be the result of the default port 3000 being occupied by another service. If so, simply change line 11 in app.js to another port number and run npm start again.

CrossCompare Testing

Unit testing of CrossCompare's functions is done using mocha with the help of chai assertion library.

To run the testing code, simply run execute ./node_modules/.bin/mocha from within the CrossCompare-js folder.

Experiment Set-up

The experiment access is not shown on the main page, yet can be accessed via opening http://localhost:3000/experiment in your web browser when the CrossCompare-js Node.js server is running (see 'Installation').