Thr0w Client
Introduction
The Thr0w Project is about building inexpensive and manageable interactive (or not) digital signage using commodity hardware, web technologies, and open source software. The key to this solution is having one computer behind each screen networked to a single computer acting as a server. With this design, the splitting and synchronization of content is accomplished through software.
This repository provides the project's Thr0w (Client) API for the project's required Thr0w Server implementation available at:
https://github.com/larkintuckerllc/thr0w-server
The Thr0w API has only been tested against modern versions of Chrome Browser.
Installation
Download the latest version and serve as static files from a web server:
https://github.com/larkintuckerllc/thr0w-client/releases
or using Bower:
bower install thr0w-client
For local development, one can use one of the following to spin up a lightweight development server.
- Python: python -m SimpleHTTPServer 8888 &
- Python 3+: python3 -m http.server 8888 &
- PHP: php -S localhost:8888
- Ruby: ruby -run -e httpd . -p 8888
- Node.js: npm install http-server -g; http-server
This library is dependent on the socket.io.js library provided by the Thr0w Server implementation.
To install, simply add the CSS library to the HTML head, e.g.:
<link rel="stylesheet" type="text/css" href="ROOT/dist/thr0w-base.css">
and the JavaScript library to the HTML body after the socket.io.js entry, e.g.,
<script src="ROOT/dist/thr0w-base.min.js"></script>
where ROOT is the URL path to the root folder of the download.
Usage
The examples provided in ROOT/examples provide inline documentation on using the API.
The API reference is available at:
http://rawgit.com/larkintuckerllc/thr0w-client/master/doc/index.html
Contributing
Submit bug or enhancement requests using the Github Issues feature. Submit bug fixes or enhancements as pull requests. Specifically, follow GitHub's document Contributing to Open Source on GitHub.
https://guides.github.com/activities/contributing-to-open-source/
The CSS and JavaScript need only be tested against the latest version of Chrome Browser.
To compile, install the development dependencies using npm and compile with gulp.
Where possible, the CSS and JavaScript is not to require any third-party libraries (outside of the socket.io.js client library).
CSS entries are prefixed with thr0w_base_.
The CSS is to follow the BEM naming convention.
https://css-tricks.com/bem-101/
The JavaScript is to pass JSHint with the default configuration. The JavaScript is to pass JSCS with the Google preset.
The JavaScript is to comply with the following style guide.
- Code is to be wrapped in an Immediately Invoked Function Expression (IIFE); no globals (outside of thr0w).
- Functionality is to be exposed as properties on the global thr0w object.
- Use named functions instead of passing an anonymous function in as a callback.
- Define functions in the scope where they are used.
- Place functions declarations at the end of the scope; rely on hoisting.
note: Unfortunately, care needs to be taken to avoid naming collisions between contributed module names and properties defined in this library on the thr0w object.
The exposed JavaScript classes (or objects) are to be documented using YUIDoc.
Credits
TODO
Contact
General questions and comments can be directed to mailto:john@larkintuckerllc.com.
License
This project is licensed under GNU General Public License.
