How to Install the RUN3TV Application Starter Kit

Step 1 - Make a new application folder

Create a directory or folder to contain the application files:
$ mkdir my-app
Change to the folder created in the step above:
$ cd my-app
[OPTIONAL] for Developers: Link or open folder created above with your IDE or Software Control Management.

SCM process and setup is out of scope for this document.

Step 2 - Access the Application Framework NPM Repository

Using NPMJS Tokens for access

npmjs tokens allow others in your organisation and CI process to access the token without having to provide user credentials.

Create an Access Token in NPMJS site SVqEUpqk4PTYY1nGfnvfR355i4K
Create a file in the my-app called .npmrc and provide the following details //registry.npmjs.org/:_authToken=${NPM_TOKEN}
Store the token as an environmental variable called NPM_TOKEN
export NPM_TOKEN=SVqEUpqk4PTYY1nGfnvfR355i4K

An NPMJS account with the A3FA is assumed to be setup and working for this step.

2. Initialise a new initial source package:
npm init -y

3. Import all the LATEST dependencies:
npm exec @a3fa/a3fa-broadcaster-starter-kit@latest

To download a specific version of the broadcaster-starter-kit, add the version numbers to the command as shown in the examples below:

Release v1.5.0
npm exec @a3fa/a3fa-broadcaster-starter-kit@1.5.0

4. Install all the dependencies (both framework and development tools):

npm install

ERROR: If you see the following message when running 'npx @a3fa/a3fa-broadcaster-starter-kit'

npm ERR! code EINTEGRITY
npm ERR! sha512-ey4V4yTCs+4j6ZeLexhFbkceoJHPWPOLN544FNbF2aXaISz4/QBpvC40tlsTZQWFM98GpoZCBZaMshl+apUe/g== integrity checksum failed when using sha512: wanted sha512-ey4V4yTCs+4j6ZeLexhFbkceoJHPWPOLN544FNbF2aXaISz4/QBpvC40tlsTZQWFM98GpoZCBZaMshl+apUe/g== but got sha512-VoXyuF+p4pxEpq7uEPJkAu3d29BZys0Dz1utInMtTRo75e91Z+lrSWBhpK474OMZsfutyUgolno5HvPnciK6sw==. (1284243 bytes)

Try running the same command again.

Step 3 - Build the Entire Application (public directory)

Build the application libraries.

Build the entire application using the command below:
npm run build -y

The command above is supported on NPM v6.x or below. Problems may occur if using NPM v7 (which is automatically installed on NodeJS v15 or higher)

Solution is to either use NPM v6 OR run the commands below as an alternative install method.

npm install --global yarn

yarn run build -y

Step 4 - Run the Application Locally on PC

Note: The executable file must have the right to execute on your platform. Please action one of the following steps to provide the permission.

Permissions by OS

Windows
Windows OS will ask for permission on the first run (pop-up window)

Mac
Apply the following cmd:
chmod +x node_modules/@a3fa/a3fa-atsc3-emulator/atsc3-receiver-emulator-macos-x64

Then start the application and local service.

Linux/Unix
Apply the following cmd:
chmod +x node_modules/@a3fa/a3fa-atsc3-emulator/atsc3-receiver-emulator-linux-x64

Starter kit file system

For 1.6 and 1.7 releases

Once the starter kit has been installed, the example stations /applications in the default Broadcaster starter kit are located under /public/a3fa-examples/apps/common-app/

For 1.8 and 1.9 release

In 1.8 release, a slightly modified and improved folder structure has been introduced. This is essentially to make the Starter Kit more representative of real life 'MARKET / STATION' set-up. The key difference are:

a) /a3fa-common/ folder is now called /run3tv-common/ folder.

b) /a3fa-examples/ folder is now the market name (e.g. /london/ in the starter kit)

c) Market folder (/london/) contains different Stations as well as other 3rd party applications that may be needed across various stations in that market.

d) applsList.json file now resides at Market folder level.

Launch Application by OS

The command structure to launch the application does vary between Framework versions. Check the information in the following article:
How to configure and use the Emulator