Important: Parts of this development guide are out-of-date.
During the development of this prototype we used the OptiTrack tracking system by NaturalPoint to capture device locations. The server listens (see oscReceiver) on OSC network messages containing the corresponding device locations.
As describe in the README, the app can also be used without such a tracking system.
- Load the root folder in WebStorm and open the Project tab.
- Right-click on
package.jsonand choose Run 'npm install' - this installs all required modules (dependencies). - In the menu, click on Run and Edit Configurations....
- In the new window, click + in the top left corner and choose npm from the dropdown list.
- Enter
start vistilesinto the field name. - Enter
startinto the field scripts. - Click Apply and then OK.
- Start the app via
Ctrl+Ror click the Run button (top right).
The structure differs from the the default Express project structure:
| dir/file | description |
|---|---|
| (build) | generated directory for transcompiled typescript files |
| client | client source code |
| data | data sets |
| (node_modules) | generated node directory for modules |
| public/ | browser (client) files (e.g., css, js) |
| server | server source code |
| (storage) | generated directory used as the servers' local storage |
| package.json | package configuration (e.g., scripts, dependencies) |
The app uses multiple npm packages:
| package | description |
|---|---|
| body-parser | middleware parsing http body |
| cookie-parser | middleware parsing cookies |
| winston | logging |
| express | Express app |
| jade | Jade templates |
| morgan | http request logging |
| serve-favicon | favicon |
| osc | osc receiver / sender |
| nconf | config module |
| socket.io | websockets module |
| node-sass | Dependency for node-sass-middleware, required to force a specific version |
| node-sass-middleware | scss file renderer |