SPOT - extensible facet browser

How to run it

Make sure you have git installed on your system.

Prerequisites for running SPOT as stand-alone website using crossfilter:

follow the instructions to install node.js:
- via package manager (suggested)
- Binaries

clone this repository:

git clone https://github.com/NLeSC/spot.git && cd spot

install dependencies:
```
npm install
```
Note: some dependencies may require node-gyp. If you get errors during compilation of this package, you may need to install following packages on Ubuntu system or equivalent packages for your distribution.
```
sudo apt-get install -y build-essential python libpq-dev
```
start the web server
```
npm start
```
open http://localhost:9966 in a web browser

Building the website is only tested on Linux, but it should work on any OS (Mac OS X for example) that is supported by node and npm.

Hosting the site can be done by any webserver.

Make sure that Javascript is enabled in your web browser. SPOT is fully functional in Google Chrome and Chromium web browsers and it should work in other web browsers. Otherwise, please submit an issue.

SQL Database

Spot can also work with a PostgreSQL database, but this requires either a local or a remote service to run. Commutication between the client and the database server is achieved by using web socket.

In order to use SPOT with a PostreSQL server, you need to clone the spot-server repository and follow the instructions in the README. In general, these are the steps to follow:

make sure that PostreSQL service is runnning.
upload your data to the database with the spot-import.js script
run the SPOT-server with the spot-server.js script

Desktop version

Desktop version of SPOT is still under development. Available downloads can be found here.

Documentation

The spot documentation can be found here.

Credits

Jisk Attema, the Netherlands eScience Center

Ampersand by folks at &yet Get the book: http://humanjavascript.com

elboyran / spot