Skip to content

Latest commit

 

History

History
44 lines (34 loc) · 2.4 KB

README.md

File metadata and controls

44 lines (34 loc) · 2.4 KB

npm David Dependency Status David Dev Dependency Status David Peer Dependencies Status Windows Build GitHub

Tournament Status

Rational

Keeping the Robot matches running according to the schedule is important because

  1. match schedules are often interleaved with other activities such as Judging sessions
  2. teams need to know when to get to the queuing area. Field queuers need to know when to call teams. If matches are not running on time then they can't know when to be ready
  3. Tournament organizers have other time constraints too, and will want competitions to finish on time.

A display driven by the Schedule and Timer Module will help the Robot Competition Area (RCA) manager, the MCs, the Head Ref and the Head Queuer keep the matches on time.

You can read more here

Techincal details

This module is a web module (see the Module Standard). It runs on react-js.

Development

  1. Fork this repository or create your own branch here
  2. make some changes
  3. create a Pull Request
  4. Wait for a CR from the code owner
  5. make sure everything is well
  6. merge

To run in development

  • Run yarn install first
  • Run yarn start to run the webpack-dev-server

To Publish to NPM

To publish the package run command yarn publish.

A few things to notice while developing:

  • Use yarn not npm
  • Follow javascript standard as described here
  • Keep the service lightweight
  • Follow the API of the other modules.
  • Be creative and have fun