# T2D Realtime Multidisplay Application Framework

The framework revolves around groups of modules that can be pushed to connected clients by the server (automatically or through admin control).

## Getting Started

* Clone the project
* CD into the new cloned directory
* [Install Ruby Compass](http://compass-style.org/install/)
* Run `npm install` to install node dependencies
* Run `gulp` to build the project and start a test server
* View the build at [http://localhost:8080](http://localhost:8080)
* Edit the source files and gulp watch automatically rebuilds the project

# --- INFO BELOW IS UNFINISHED/OUTDATED ---

## Server
### Router
The router provides access control for admin pages and module generated routes.

### Socket
The socket provides an api for managing rooms and passing messages between clients.

## Client
### Scripts
A basic module loader that is controlled by socket signals.

### Styles
Core styles for fluid layout.

### Templates
Intro templates for client and admin sections.

## Admin
### Module Settings
Data admin panel to manage JSON settings of modules.

### Live Module Management
Realtime admin panel for module management and sequencing.

## Module
### Server Module
The module will need to provide socket middleware and model loading/ manipulation.

### Client Module
Scripts, styles & templates.

### Admin Module
Scripts, styles & templates.