/Browser-Extension

Browser extension for Screenly that works with Firefox and Chrome.

Primary LanguageJavaScriptApache License 2.0Apache-2.0


Extension Banner


GitHub Actions Workflow Status GitHub Actions Workflow Status
Chrome Web Store Version Mozilla Add-on Version


Easily add content to your Screenly digital signage displays in a few clicks. ✨


🌱 Install

💻 Develop

The extension is built using webpack. Please check our contributing guidelines for detailed information about opening pull requests and releasing new versions.

$ PLATFORM=<PLATFORM> \
  VERSION=<VERSION> \
    ./bin/start_development_mode.sh

Important

  • VERSION can be any valid version semver string (X.Y.Z), where X, Y, and Z are non-negative numbers.
  • PLATFORM can be either chrome or firefox.

Now load the content of the dist/ folder as an unpacked extension in Chrome. As you make changes to the code, the extension is automatically rebuilt.

Distribute

$ VERSION=<VERSION> \
  PLATFORM=<PLATFORM> \
    ./bin/package_extension.sh

🧪 Run Unit Tests

$ ./bin/run_tests.sh

Chrome

  • Build the extension in dev mode.
  • Load the extension as an unpacked extension from the dist folder.
  • Find the extension URL and then open chrome-extension://<extension-id>/test/tests.html in Chrome.

Firefox

  • Build the extension in dev mode.
  • Open Firefox and navigate to about:debugging.
  • Click on This Firefox and then Load Temporary Add-on.
    • You can either select the manifest.json file or the zipped extension.
  • Find the extension URL and then open moz-extension://<extension-id>/test/tests.html in Firefox.