Skip to content

BSStudio/robonaut-server

Repository files navigation

RobonAUT Server

CircleCI GitHub Release Date GitHub Tag GitHub branch checks state Codecov branch Swagger Validator GitHub code size in bytes GitHub Bugs Code Smells Duplicated Lines (%) Lines of Code Maintainability Rating Quality Gate Status Reliability Rating Security Rating Technical Debt Vulnerabilities GitHub deployments


RobonAUT is an annual robot competition organized by the Faculty of Electrical Engineering and Informatics of Budapest University of Technology and Economics, dating back more than a decade. The event is livestreamed by BSS, one of the university student-operated video studios. During the live broadcast, we wanted to show live data to our viewers. The organizers followed the events of the races in their own software. To display the events, we created software that uses CasparCG to display the data on the stream.

This program persisted the events of the tournament and broadcasted the details of the events to the playout software.

---
title: Architecture
---
graph RL
rcs["Race Control Software"]
server["Robonaut Server"]
db["MongoDB"]
playout["Playout Server"]
cg["Caspar CG"]

rcs --> server
db <--> server
server <-- Rabbit MQ --> playout
playout --> cg
Loading

Run the application

Using docker compose

docker compose up -d

Using gradle

./gradlew bootRun

Dependencies

The project using MongoDB as its persistent storage.
For message broadcasting RabbitMQ is used.

Environment variables

The required environment variables can be found here:
application/src/main/resources/META-INF/additional-spring-configuration-metadata.json
For MongoDB and RabbitMQ specific variables visit Spring Boot documentations.

Documentation

To access the documentation run the application and navigate to http://localhost:8080/.