https://github.com/emadalam/tvml-catalog-using-atvjs
Port of the TVML Catalog Sample Code re-written using atvjs
https://github.com/emadalam/tvml-catalog-using-atvjs
apple-tv appletv-demo atvjs tvjs tvml-catalog tvml-demo
Last synced: 6 months ago
JSON representation
Port of the TVML Catalog Sample Code re-written using atvjs
- Host: GitHub
- URL: https://github.com/emadalam/tvml-catalog-using-atvjs
- Owner: emadalam
- License: mit
- Created: 2016-01-29T20:46:42.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-11-03T19:20:37.000Z (almost 9 years ago)
- Last Synced: 2025-03-29T08:43:59.296Z (6 months ago)
- Topics: apple-tv, appletv-demo, atvjs, tvjs, tvml-catalog, tvml-demo
- Language: HTML
- Homepage: http://emadalam.github.io/tvml-catalog-using-atvjs
- Size: 70.6 MB
- Stars: 35
- Watchers: 7
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TVML Catalog: Using atvjs framework
This is a port of the original [TVML Catalog Sample Code](https://developer.apple.com/library/tvos/samplecode/TVMLCatalog/Introduction/Intro.html) re-written using [atvjs](https://github.com/emadalam/atvjs) framework. Refer to the framework documentation for its usage details.
### Getting Started
Assuming that you have [nodejs](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed on your machine, do the following to get started:
```shell
$ npm install -g gulp karma-cli # Install Gulp and Karma globally
$ npm install # Install dependencies
```
### Development
Builds the application and starts a webserver. By default the webserver starts at port 9001.
```shell
$ gulp
```
By default, it builds in debug mode.
* If you need to build in release mode, add `--type production` flag.
* You can define a port with `--port 8080` flag. (If you start the server on a different port, make sure to update the same in the native application)
* If you need to run tests while building/starting the application, add `--tests` flag.
* To run just the test suite, `gulp test` or `karma start`
### Structure
The project is split into two parts:
- native: this directory contains the Xcode project and related files. The AppDelegate.swift file handles the setup of the TVMLKit framework and launching the JavaScript context to manage the application.
- web: this directory contains the JavaScript and TVML template files needed to render the application. The contents of this directory must be hosted on a server accessible from the device.
### License
[MIT License](http://opensource.org/licenses/MIT).