Skip to content

An open source Javascript-based zoomable video player and server. The server runs on node.js, using Sails framework; The front-end on Angular. The video player is based on Google's Shaka player.

License

nus-mtp/zoomable.js

Repository files navigation

zoomable.js Build Status

Overview

This is an open-source HTML5 video player that allows users to zoom in with greater detail and pan around the video with bandwith efficiency. The Javascript-based zoomable video player streams dash-compliant videos and adapts to network conditions to provide continuous video playback by reducing the video resolutions where necessary.

Demo Video

Setup with Docker

Install the necessary pre-requisites

Setup

To build the image:

$ docker build -t <your-username>/<repository-name> .

Then run the built image:

$ docker run -it -p 1337:1337 --entrypoint='bash' <your-username>/<repository-name> 

Setup without Docker

Installing the necessary pre-requisites

The following packages are required for using zoomable.js:

Install necessary packages

Run the npm and bower install commands to install the packages that the project requires.

For bash:

$ npm install -g bower grunt-cli
$ npm install 
$ bower install 

Additional Configurations

Make the video-processing script executable.

$ cd scripts
$ chmod +x video-processing.sh

Start the Server for Development

Start the server by running the Sails command:

$ sails lift

If this server is setup locally, open your browser and enter the url: http://localhost:1337 to visit the main webpage of the project.

Start the Server for Production

Start the server in production by running the following command:

$ node app.js --prod

Detailed settings can be found in the development guide

Tests

Mocha and PhantomJS are used for frontend and backend testing.

To run the full test suites:

$ grunt test

Documentation

Detailed documentation can be found in the development guide

Team

Team Meteoria

Supervisors

License

Copyright (c) 2016 Team Meteoria. Licensed under the MIT license.

About

An open source Javascript-based zoomable video player and server. The server runs on node.js, using Sails framework; The front-end on Angular. The video player is based on Google's Shaka player.

Resources

License

Stars

Watchers

Forks

Packages

No packages published