Skip to content

Latest commit

 

History

History
128 lines (79 loc) · 5.65 KB

README.md

File metadata and controls

128 lines (79 loc) · 5.65 KB
Raw

BrightSign Logo

BrightSign Dev Cookbook

License Build Status

Introduction

Welcome to the BrightSign Dev Cookbook! Here you will find example code and projects for your BrightSign digital signage devices that demonstrate various capabilities.

Whether you're a beginner eager to dive into BrightSign development, or an advanced developer looking to expand your skills, this cookbook offers a wide range of examples to demonstrate the capabilities of these devices.

Table of Contents

Installation

To use the examples and templates in this repository, you'll need to clone the repository and navigate to the relevant directory.

git clone https://github.com/brightsign/dev-cookbook.git
cd dev-cookbook

Using this resource locally

To use this repository locally, use the git clone functionality. To do this, click the green <> Code button in the top right and copy the HTTP or SSH URL to your clipboard. Then, in your terminal or command line, run the following:

git clone https://github.com/brightsign/dev-cookbook.git

Examples

Overview

The examples in this repository are designed to help you get started with developing on a BrightSign player. These examples serve as stepping stones, allowing you to build and expand your understanding of the platform.

Learning the basics with examples

If you've never worked with a BrightSign before, we recommend starting with a barebones example.

After this, we recommend integrating Node.js into the application on the BrightSign player. An example of this can be found in html_node_example.

Once this seems familiar, we recommend adding auxiliary tools to make the development experience smoother. This includes introducing a script to copy files to the player's SD card, defining multiple environments to develop locally rather than needing to only rely on the player for visibility, and a mock library for populating values when running the example locally. This can be found here.

From here, we recommend using one of the templates to start developing your own project!

Templates

Overview

The templates in this repository are starter projects that you can use to begin development on top of existing setups. These templates are designed to provide a solid foundation, allowing you to hit the ground running with your BrightSign projects.

Hit the ground running with templates

The templates in this repository are intended for developers who are familiar with Node.js, React, and running scripts that connect to devices over a local network.

We recommend managing your Node.js version using nvm. The preferred version is 14.17.6 since this is the version currently pre-installed on most BrightSign devices.

Project structure

Here's an overview of the project structure and what each part is responsible for:

  • templates/ : React templates for new projects with custom configurations tailored for BrightSign development.
  • examples/ : A collection of examples demonstrating different capabilities and how to implement them on your BrightSign device.
  • .github/ : Contains GitHub Actions configurations for automated build and deployment processes.
  • scripts/ : Utility scripts to facilitate build, deployment, and development workflows.
  • .eslintrc : Lint configuration to ensure code quality and consistency across the project.
  • package.json : Manages project dependencies and scripts for an efficient development workflow.

Getting Started

This monorepo uses yarn workspaces to manage dependencies and run commands. Simply run yarn install from the workspace root and explore the examples!

To run the tests for every example, run yarn workspaces run test or the shortcut yarn test.

Feedback/Contributing

We welcome contributions to the BrightSign Dev Cookbook! Please see our Contributing Guidelines for more information.

Feel free to open an issue or submit a PR; see CONTRIBUTING.MD for further information.

Building on M1 Mac

You might see an error like npm ERR! Error: Cannot find module 'node-bin-darwin-arm64/package.json'

Run the following commands:

> node -v
v14.17.6
> node -p process.arch
arm64
> arch -x86_64 zsh
> nvm uninstall 14.17.6 && nvm install 14.17.6

You might need to do this each time you restart your terminal.

For more details, see this Stack Overflow thread.

Support

If you have any questions or need help, please open an issue on this repository or contact BrightSign support.

License

This project is licensed under the MIT License. See the LICENSE file for details.