Refactoring BrightSign Starter Project Public Github Repo #26
Conversation
mxin512
commented
Apr 24, 2023
mxin512
commented
- Included comprehensive examples and README
- Included comprehensive examples and README
| ### Publishing | ||
| After running Webpack, follow these steps to create your presentation: | ||
|
|
||
| You can publish the HTML/JS application by copying the contents of the /dist folder to your SD Card, adding the autorun.brs file found in the /opt folder as a standalone autorun, and booting up your player. |
There was a problem hiding this comment.
This should mention something about this being used for development purposes. Productizing this approach would require additional development to clear development flags, secure the app, and managing app updates.
| |_style.css | ||
| index.html | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Add a caveat that a basic understanding of javascript, html, css, node, are all required.
| ' change URL to be your live-server address | ||
| url: "file:///index.html", | ||
| javascript_enabled: true, | ||
| nodejs_enabled: true, |
There was a problem hiding this comment.
If this is the HTML app, this should be removed. Along with all other node-isms throughout this example.
| brightsign_js_objects_enabled: true, | ||
| storage_path: "sd:/browser_data", | ||
| hwz_default: "on", | ||
| security_params: { websecurity: false }, |
There was a problem hiding this comment.
Add comment that this will need to be enabled for productizing this.
| "main": "./src/scripts.js", | ||
| "scripts": { | ||
| "test": "echo \"Error: no test specified\" && exit 1", | ||
| "install-webpack": "npm install --save-dev webpack webpack-cli copy-webpack-plugin", |
There was a problem hiding this comment.
What is the reason for this to be a script?
Would it make sense to let npm i install the devDependencies instead of having a script to do so?
| * If you don’t have it already, download Nodejs to install Node.js and npm. | ||
| ## Install | ||
| * Download [Nodejs](https://nodejs.org/en/download), if you don’t have it already, to install Node.js and npm. | ||
| * Your computer and BrightSign player must be connected to the internet. |
There was a problem hiding this comment.
What's the internet connection for?
| ## Starting Samples | ||
| ### Example1 HTML-JS-Application | ||
| This is a pre-made starter HTML/JS project that is already configured with webpack to create a folder with everything that needs to be copied to a BrightSign SD Card, or added to an HTML Widget in BrightAuthor/BrightAuthor:connected. If your application contains full-stack solution with HTML, CSS and JavaScript, this is the recommended starting project, and please navigate to the /HTML-JS-Application folder for more instructions. | ||
|
|
There was a problem hiding this comment.
Prerequisites category may be also helpful for each example.
| * BrightAuthor / BrightAuthor:connected should already be downloaded and installed on your computer. | ||
|
|
||
|
|
||
| ## Starting Samples |
There was a problem hiding this comment.
Knit: new line after this header.
| * An example is included to help you use [BrightSign Javascript objects](http://docs.brightsign.biz/display/DOC/JavaScript+API). See the "externals" section of the webpack.config.js. | ||
| * See the BrightSign [Node.js documentation](http://docs.brightsign.biz/display/DOC/Node.js) for more information. | ||
| * The node_modules directory contains a lot of unnecessary files in addition to the code your application needs, and its size can be a problem when you deploy your application to an SD card or publish it through BrightAuthor / BrightAuthor:connected. [Webpack](https://webpack.js.org), which bundles JavaScript modules to use in browsers, solves this problem. | ||
| * If you would like to use [BrightSign Javascript objects](http://docs.brightsign.biz/display/DOC/JavaScript+API) with webpack, please see the "externals" section of /HTML-JS-Application/webpack.config.js. |
There was a problem hiding this comment.
This should be Javascript APIs.
We're trying to steer away from BrightSign Javascript Objects.
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the BrightSign License - see the LICENSE file for details |
There was a problem hiding this comment.
What is the brightsign license?
We may want to just update these to be the MIT License.
