https://github.com/hypery2k/generator-tvml
TVML Yeoman Template to create tvOS apps
https://github.com/hypery2k/generator-tvml
Last synced: 4 months ago
JSON representation
TVML Yeoman Template to create tvOS apps
- Host: GitHub
- URL: https://github.com/hypery2k/generator-tvml
- Owner: hypery2k
- License: mit
- Created: 2016-06-15T09:15:02.000Z (almost 10 years ago)
- Default Branch: develop
- Last Pushed: 2026-02-12T17:39:28.000Z (4 months ago)
- Last Synced: 2026-02-13T01:13:38.251Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 136 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# TVML Yeoman Template
[](https://greenkeeper.io/)
[](https://travis-ci.org/hypery2k/generator-tvml) [](http://badge.fury.io/js/generator-tvml) [](https://codeclimate.com/github/hypery2k/generator-tvml) [](https://david-dm.org/hypery2k/generator-tvml) [](https://david-dm.org/hypery2k/generator-tvml#info=devDependencies)
> The template provides a basic TVML sceleton for tvOS which uses WebPack and LiveReloading to build apps for the AppleTV platform
[](https://nodei.co/npm/generator-tvml/)
> Feel free to **donate**
>
> 
>
> 
>
> Or donate [Bitcoins](bitcoin:3NKtxw1SRYgess5ev4Ri54GekoAgkR213D):
> [](bitcoin:3NKtxw1SRYgess5ev4Ri54GekoAgkR213D)
>
> Also via [greenaddress](https://greenaddress.it/pay/GA3ZPfh7As3Gc2oP6pQ1njxMij88u/)
## Usage
```
(sudo) npm install -g yo generator-tvml
yo tvml
```
Or the develop build, which maybe **not be stable**
```
(sudo) npm install -g yo generator-tvml@next
yo tvml
```
## About
This is a basic template which uses [atvjs](https://www.npmjs.com/package/atvjs) framework for blazing fast [Apple TV](https://developer.apple.com/tvos/) application development using pure JavaScript. It relies on the [tvOS](https://developer.apple.com/tvos/) provided [TVML](https://developer.apple.com/library/prerelease/tvos/documentation/LanguagesUtilities/Conceptual/ATV_Template_Guide/) and [TVJS](https://developer.apple.com/library/prerelease/tvos/documentation/TVMLJS/Reference/TVJSFrameworkReference/) for [Apple TV development](https://developer.apple.com/library/tvos/documentation/General/Conceptual/AppleTV_PG/). However this framework does most of the heavy lifting for you and lets you concentrate on your application logic without worrying about the hassles of complicated architecture for Apple TV development. Build your Apple TV application the same way how you are used to building your SPA applications in JavaScript and let the framework handle the rest for you.
This template also includes livereloading and modules with WebPack and ES2015.
Feel free to **donate**
## Creating Pages
Create pages in your application using the page factory. You will then be able to navigate to these pages using the name of the page.
```
ATV.Page.create({
name: 'home',
// use a template function from your favourite templating engine
// or pass a raw template function
template(data) {
return `
${data.title}
${data.description}
`;
},
// pass some raw data to be applied
// or a data function that returns the data
data: {
title: 'Homepage',
description: 'This is my super awesome homepage created using atvjs.'
}
});
// later in your application you can do something like below to navigate to the page
ATV.Navigation.navigate('home');
```
Or you can use the jade loader:
```
import alertTemplate from './templates/alert.jade';
ATV.Page.create({
name: 'home',
// use a template function from your favourite templating engine
// or pass a raw template function
template: alertTemplate,
// pass some raw data to be applied
// or a data function that returns the data
data: {
title: 'Homepage',
description: 'This is my super awesome homepage created using atvjs.'
}
});
// later in your application you can do something like below to navigate to the page
ATV.Navigation.navigate('home');
```