0.1.0 • Published 5 years ago

@grid23/bs-react-app v0.1.0

Weekly downloads
2
License
-
Repository
github
Last release
5 years ago

bs-react-app

Fast setup of a work environment to create a create-react-app based html widget/plugin on brightsign.

usage

npx @grid23/bs-react-app ./myplugin

what it does

npx @grid23/bs-react-app name
will do
at installation
- install create-react-app at [name]
- eject create-react-app at [name]
- create folders [name]/brightauthor, [name]/dist, [name]/plugin )
- inject a backbone templated brightscript plugin at [name]/plugin/plugin.brs
- inject scripts in [name]/scripts
- modify [name]/package.json
		- add config key, and key->value pairs
		- modify scripts
		- change browserslist to chrome >= 65
when starting/building the app
- generate a brighscript plugin at [name]/dist/[name].brs
- generate a zip with all necessary sources and assets at [name]/dist/[name].zip
how to start to work directly on your brightsign hardware
- make sure all your hardware is on the same network
- start the brightsign player without a SD card, to learn its IP address
- create a project in brightauthor ( example: [name]/brightauthor/[name].bpf
- in presentation properties > autorun 
		add your generated plugin [name]/dist/[name].brs
        name it [name] (mandatory)
- in presentation properties > files
		add your generated zip [name]dist/[name].zip
- at any state you want to start your plugin, add these entry commands :
		send > send plugin message > [name] > init
        send > send plugin message > [name] > show
- publish your presentation with firmware 8+ (if you want to use firmware 7, change browserslist to chrome >= 45)
- make sure the create-react-app server is running ( npm start )
- start the brightsign player with a SD card containing your published presentation
- if everything works fine, you should see the homepage of create-react-app
- start editing app.js
- ???
- profit
to do
- add documentation
- during installation, modify webpack.config.js to enable working with native node modules inside your app
- create add-ons to enable complex interactions between the hardware and javascript