Skip to content

Latest commit

 

History

History
71 lines (57 loc) · 2.32 KB

README.md

File metadata and controls

71 lines (57 loc) · 2.32 KB
Raw

CircleCI Go Report Card Go Doc Release Coverage

SSL Status Board

A Status Board for the Small Size League, optimized to show the current game state on a large screen.

Usage

If you just want to use this app, simply download the latest release binary. The binary is self-contained. No dependencies are required.

You can also use pre-build docker images:

docker pull robocupssl/ssl-status-board
docker run -p 8082:8082 robocupssl/ssl-status-board

By default, the UI is available at http://localhost:8082

A configuration file will be generated to config/board-config.yaml and can be tweaked.

Runtime Requirements

  • No software dependencies (except for development, see below)
  • 64bit Linux, Windows, OSX (build your 32bit binaries yourself...)
  • A reasonable Web-Browser (mostly tested on Chrome)

Development

Requirements

You need to install following dependencies first:

  • Go >= 1.13
  • Node
  • Yarn

Prepare

Download and install to GOPATH:

go get -u github.com/RoboCup-SSL/ssl-status-board/...

Switch to project root directory

cd $GOPATH/src/github.com/RoboCup-SSL/ssl-status-board/

Download dependencies for frontend

yarn install

Run the backend

go run cmd/ssl-status-board/main.go

Run the UI

# compile and hot-reload
yarn serve

Build self-contained release binary

./install.sh

Rebuild Protobuf code

yarn run genProto