@first-lego-league/display
v2.7.2
Published
A Display module for the big screen in FIRST LEGO League competitions.
Downloads
113
Keywords
Readme
Display
A Display module for the big screen in FIRST LEGO League competitions.
Background
There are several things that tournament officials would like to appear on their big screen:
- A Rankings Table
- A Match Timer
- Logos of sponsors
- Competition Title & Logos This module is meant to display these to the teams in an eye-pleasing manner, which is informative and intuitive, with data that updates at real-time.
Future additions:
- Up next
- Camera feed
Techincal details
This module is a web
module (see the Module Standard). It runs on react-js.
Development
- Fork this repository or create your own branch here
- make some changes
- create a Pull Request
- Wait for a CR from the code owner
- make sure everything is well
- merge
To run in development
- Run
yarn install
first - Run
yarn mhub
to start mhub with the correct configuration which sits indev/mhub.config.json
- Run
yarn start
to run thewebpack-dev-server
To Publish to NPM
To publish the package run command yarn publish
.
A few things to notice while developing:
- Use
yarn
notnpm
- Follow javascript standard as described here
- Keep the service lightweight
- Follow the API of the other modules.
- Be creative and have fun