FanConnect Template Preview
This library provides an environment for developing templates that will run on the FanConnect platform.
Requirements
- Node.js >= 16.17.0
Usage
As a Development Dependency
This is the recommended approach as it allows you to control the version used more easily:
# npm
npm install --save-dev @fanconnecttv/preview
# yarn
yarn add -D @fanconnecttv/previewAt this point you can run the previewer via:
# npm
npx preview
# yarn
yarn previewWith npx
With npx you can run the previewer without declaring it as a dependency. It is recommended to use
@latest to avoid using older cached versions:
npx @fanconnecttv/preview@latestOptions
| Option | Type | Default | Description |
|---|---|---|---|
-d/--dir
|
string | ${PWD}/dist |
Directory containing index.html |
-h/--help
|
boolean | false |
Display help message and exit |
-o/--open
|
boolean | false |
Open preview in default browser |
-p/--port
|
string | 1234 |
Port to listen on, if available |
-v/--version
|
boolean | false |
Print version and exit |
If the configured port is in use, an open port will be selected.
If -h/--help or -v/--version is specified, other options will be ignored.
By default, the previewer will look for index.html in a directory called dist/ in the current
working directory.