Setup environment

Start your development easily, locally, and with your preferred IDE. Install signageOS CLI, develop your Applet (HTML5 player) and deploy first devices.

What you will need

You need the following stack to get started with your development:

• signageOS Account
• having at least one Organization in the Box create new one here
• Node.js >= 10.15.0 with NPM included in the file package. The latest stable Node version you can find on the following site: https://nodejs.org/en/download/ If necessary, the previous Node releases can be found on the site: https://nodejs.org/en/download/releases/
• Shell, Gitbash, Powershell, Windows Terminal, or Cmder.

tip

Windows Terminal and Cmder allows open more than one console window which can be helpful in the daily development work.

signageOS CLI

signageOS CLI is a command-line tool for rapid local development that brings you the ability to easily start developing on top of the signageOS framework from your favorite IDE.

Installation

Terminal

npm install @signageos/cli -g
sos --help

It may happen that the sos command won't be recognized. In this situation reinstall the Node.JS with the NPM package on your system. If necessary, please install the older version of the package but not older than v10.15.0

info

The full documentation can be found on the signageOS Github. Once installed, you can use sos --help for quick help within the CLI.

tip

The best way for managing the Node.js and NPM environments is nvm. Read more here.

Log in

Once installed, log in to the CLI with your signageOS Account.

Terminal

sos login

Set up default Organization

CLI allows you to manage Applets, devices and tests from multiple organizations. Choose your default one which will be used for development and testing.

If you do not have one yet, create it in signageOS Box

Terminal

sos organization set-default

Now you are all set. Continue by generating your Applet boilerplate.