README.md 1.26 KB
Newer Older
tmarrinan's avatar
tmarrinan committed
1 2 3 4
WebSAGE
=======

Browser based implementation of SAGE. A cluster-based html viewer used for displaying elements across multiple browser windows.
tmarrinan's avatar
tmarrinan committed
5

tmarrinan's avatar
tmarrinan committed
6
### Requirements ###
tmarrinan's avatar
tmarrinan committed
7 8 9
* ffmpeg
* poppler

tmarrinan's avatar
tmarrinan committed
10
##### For Windows: #####
tmarrinan's avatar
tmarrinan committed
11

tmarrinan's avatar
tmarrinan committed
12
* Download and install [Node.js](http://nodejs.org/)
tmarrinan's avatar
tmarrinan committed
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
* Download and install [7-Zip](http://www.7-zip.org/)
* Download [FFMpeg](http://ffmpeg.zeranoe.com/builds/)
* Download [Poppler-utils](http://manifestwebdesign.com/2013/01/09/xpdf-and-poppler-utils-on-windows/)

Install FFMpeg
* Move the FFMpeg 7-zip file to "C:\"
* Right-click, go to 7-Zip > Extract Here
* Rename extracted folder to "FFMpeg"

Install Poppler
* Create Folder "C:\Poppler"
* Move the Poppler-utils zip file to "C:\Poppler"
* Right-click, go to 7-Zip > Extract Here

Set Environment
* Add both "C:\FFMpeg" and "C:\Poppler" to you PATH variable
tmarrinan's avatar
tmarrinan committed
29 30


tmarrinan's avatar
tmarrinan committed
31
##### For Mac OSX: #####
tmarrinan's avatar
tmarrinan committed
32

tmarrinan's avatar
tmarrinan committed
33 34 35
* Download and install [Node.js](http://nodejs.org/)
* Download and install [homebrew](http://brew.sh/)

tmarrinan's avatar
tmarrinan committed
36 37 38
```
brew install ffmpeg 
brew install poppler --with-glib
tmarrinan's avatar
tmarrinan committed
39 40 41
```


tmarrinan's avatar
tmarrinan committed
42 43 44 45 46
=======

##### Setup Node js (Mac OSX and Linux): #####
Open keys/GO
Edit ```servers``` to be a list of hostnames for your server
tmarrinan's avatar
tmarrinan committed
47
```
tmarrinan's avatar
tmarrinan committed
48
cd <WebSAGE_directory>
tmarrinan's avatar
tmarrinan committed
49
npm install
tmarrinan's avatar
tmarrinan committed
50 51
cd keys/
./GO
tmarrinan's avatar
tmarrinan committed
52
```
tmarrinan's avatar
tmarrinan committed
53 54 55 56 57 58 59 60 61 62

=======

##### Run WebSAGE: #####
```
cd <WebSAGE_directory>
node server.js
```