Creating Your Own NodeJs Modules

Each module has to follow this folder structure and include all of these files:

|----config //folder contains the configuration file and the images
|     |----config.json
|     |----icon.png
|     |__placeholder.png
|
|----index.js //your main starting nodeJs application file
|__package.json //with the necessary npm packages listed in it

  • Please do not include the node_modules folder and the package-lock.json file of your application. The system will install all the necessary packages automatically.
  • Please also do not include any other files on any other folder level named the same as one of the required files. Any other file or folder name can be included.
  • The icon and the placeholder image has to be .png image file.
  • Make sure the root of the zip starts with the mentioned files and not with a folder.
The configuration JSON file has to contain:

See more about Editor integration and the custom parameters here.

The system will automatically assign a PORT number for each module in its environment. This port can change dynamically with every restart.
If your application has web service functionality you need to run it on the value of the PORT environment variable, process.env.PORT .

Example:

You can download a sample module here.
You can download a sample for typescript here.

Steps to able to upload this module.

  • Run npm install in the root folder of the project
  • Run npm run-script build in the root folder of the project
  • Copy-Paste package.json file and config folder to the dist folder
  • ZIP the contents of the dist folder
  • Upload the ZIP file
  • Call the endpoint (https://YOUR_SERVER/scripts/modules/MODULE_NAME/YOUR_ENDPOINT)
ABOUT WALLBOARD

Leverage Wallboard's powerful suite of tools to create, automate, and manage dynamic digital signage that your audience will remember.

Ready to Get Started?

Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.