Now that you have your developer environment created, CLI installed, and first applet built (part 1 setup your developer environement tutorial) you are ready to deploy the applet to any digital signage hardware. So how do you do this? In part 2 of the signageOS Open tutorial, you will learn how to finalize your applet build, upload to signageOS, download the core application version of your applet and deploy on any digital signage hardware!
First, let’s make sure you have the tasks below completed successfully.
- Download Node.js >= 10.15.0 and npm - You can find the latest stable Node version on the following site: https://nodejs.org/en/download/
- Download and Install signageOS CLI
- One organization created in the Box
You must also have PowerShell or Gitbash installed.
At this point you have your applet created and are happy with the behaviour that you were able to view and debug from your web browser (if you're unsure about this, please see the Developer Environment Setup tutorial.) View the build and deploy tutorial below or continue reading for even greater details.
Step 1 - Finalize Applet Build
Within your command line shell (Shell, powershell, Gitbash, etc.) you now need to build your applet by entering the following command:
npm run build. This command is different from npm start.
npm run build bundles your code so the signageOS Core Apps can easily process the applet’s contents. You should not receive any errors when completing this command.
Step 2 - Upload Applet to signageOS
Next, you need to upload your applet to the signageOS cloud via the command:
sos applet upload. The applet is uploaded to the signageOS cloud so that the applet can be processed and built using hardware-agnostic signageOS core apps. The core app build process is protected by NDA and Dev Agreements, so signageOS completes this process for you.
During the applet upload, if you receive a no “version key" found message, you must complete an additional, simple step. You must add the applet version to the applet's package.json file. You can find more information on this within the signageOS Documentation.
Once you have added the application version to the package.json file, go back to the command line interface and begin the applet upload again. After initiating the applet upload you will be asked if you want to create applet version 1.0.0 or whichever version this is for you application. Input y and hit enter.
Your applet will be uploaded to the signageOS Cloud and a URL will be displayed in your command line tool of the location of your applet within the signageOS Box (device management console). Simply copy and paste the URL to navigate to your applet or you can easily find the applet within the applets section of the Box.
Step 3 - Select the HW for the Core App Build
Within the applet’s detail page in the Box, navigate to the App Builder tab. Locate the hardware you would like to have the final, core app built for and select Build. Download and extract those files to your computer. As previously mentioned, the core app build process is protected by NDA and Dev Agreements, so signageOS completes this process for you.
Now, you can easily deploy your unique Application (THAT YOU BUILT ONCE) on ANY hardware by just choosing the hardware or platform and selecting build!
Step 4 - Deploy!
The last step is to deploy your app to the hardware that your core app was just built for. This process is hardware-specific, so it varies across the different hardware types. For example, deploying your applet on a Tizen device is very different from deploying on Raspberry Pi. Within the documentation, there are step-by-step guides for deploying on each and every hardware!
Some deployment processes might require that you upload your Core App built by signageOS to a static server. There are many companies that offer free tiers for static servers. Additional information on this topic can be found within the signageOS Documentation. Explore the various options that are out there and select the one that fits the needs of your digital signage network.
And that’s it! You have now completed the development environment setup process, successfully built your applet, and are ready to deploy your custom, cross-platform applications. signageOS Open offers users and companies a tool that is unlike any other in the digital signage industry. Hundreds of companies and developers are utilizing signageOS Open globally and the number is growing. Our goal is to make your digital signage development as easy as possible so for updates on additional tutorials and resources subscribe to the signageOS blog.