samsung/cordova-tv-webos

`cordova-tv-webos` is an TV application library that allows for Cordova-based projects to be built for the WebOS TV Platform.

cordova-tv-webos

cordova-tv-webos is an TV application library that allows for Cordova-based projects to be built for the WebOS TV Platform. Cordova based applications are, at the core, applications written with web technology: HTML, CSS and JavaScript.

Supported Platform

• WebOS LG Smart TV (tv-webos)

Supported cordova plugins

There are 3 cordova plugins which are supported on TOAST

• cordova-plugin-device
• cordova-plugin-globalization
• cordova-plugin-network-information

If you want more details, please refer Supported Cordova Plugin

Project Structure

    ./
     |-cordova-js-src/ .... cordova-js tv-webos platform implementation
     |  |-plugin/ ......... cordova plugin implementations
     |  |-exec.js ......... cordova/exec module
     |  `-platform.js ..... cordova/platform module having platform definition and bootstrap
     |-www/ ............... Project template for WebOS platform
     |-package.json ....... npm package configuration
     '-README.md .......... this file

How to Build

This section describes the build process which creates cordova.js file for the tv-webos cordova platform. Please see Cordova-js for more detail of compile task.

1. Clone the Cordova-js project as sibling of this project.

   $ git clone https://github.com/Samsung/cordova-tv-webos.git
   $ git clone https://github.com/apache/cordova-js.git

   Repositories will be created like below directory structure.

   ./
    |-cordova-js
    `-cordova-tv-webos
   

2. Add "tv-webos" as a target of "compile" task on Gruntfile.js in the cordova-js project.

   ...
   grunt.initConfig({
       pkg: grunt.file.readJSON('package.json'),
       "compile": {
           ...,
           "tv-webos": {}
       },
       "compile-browserify": {
       ...
   });

3. Add "tv-webos" property to "cordova-platforms" object in the cordova-js project's package.json with path to this project's repository as its value.

   "cordova-platforms": {
       ...,
       "cordova-tv-webps": "../cordova-tv-webos"
   }

4. In the cordova-js directory's root, run below command to create cordova-js/pkg/cordova.tv-webos.js file.

   $ grunt compile:tv-webos

5. We recommend to copy the created file to the www directory which is including WebOS Application project templates for further use. In the cordova-js directory:

   $ cp ./pkg/cordova.tv-webos.js ../cordova-tv-webos/www/cordova.js

How to use

For creating application package for WebOS TV:

1. Create a WebOS project with WebOS IDE and copy the www directory's content to the WebOS project.
2. Copy the built cordova-js/pkg/cordova.tv-webos.js to your WebOS project directory's root with name cordova.js.
3. Build the WebOS project.

• We recommand to use the grunt-cordova-sectv Grunt task to automate these process.

Known Issues

Not yet