Sportradar Challenge

Description

This project is a solution to the Sportradar Challenge. The project is a monorepo consists of a simple package "Scoreboard", which is used to keep track of the scores of different teams in a sports match.And a simple frontend application that uses the library to display the scores of the teams in a sports match.

Installation

To install the project on your local machine, you need to have the following installed:

• Node JS v20.10.0 (test and developed with this version)
• Yarn (and corepack enabled)

To install the project, follow the steps below:

1. Clone the project to your local machine
2. Navigate to the root directory of the project
3. Run yarn install to install the dependencies of the project (make sure you have yarn installed and corepack enabled)

Running the project

Docker

if you have docker compose installed on your machine, you can run the following command to run the project:

docker-compose up

this command will build the project and run the frontend application on port localhost:8080

if you don't have docker compose installed on your machine, you can run the following commands:

docker build -t sportradar_challenge .
docker run -p 8080:80 sportradar_challenge

Native

Run the following command to :

• build the library ( required to run the frontend application ):

yarn scoreboard:build

• run the frontend application in development mode:

yarn frontend:dev

• run the tests for both the library and the frontend application:

yarn test-all

Usage

The library is a simple class that can be used to keep track of the scores of different teams in a sports match.

import { Scoreboard ,Match } from 'scoreboard';

const match1 = new Match({
    homeTeam: 'Mexico',
    homeScore: 0,   // initial home score (optional)
    awayTeam: 'Canada',
    awayScore: 5    // initial away score (optional) 
});
const match2 = new Match({ homeTeam: 'Spain', awayTeam: 'Brazil' }); // initial scores are 0
const scoreboard = new Scoreboard();

scoreboard.addMatch(match1);
scoreboard.addMatch(match2);

scoreboard.getMatches(); // returns an array of matches
// [ match1, match2 ]

scoreboard.updateScore(match2
    ,5 // home score
    ,6 // away score
)
scoreboard.getMatches(); 
// [ match2, match1 ]

scoreboard.endMatch(match1);

scoreboard.getMatches();
// [ match2 ]

Notes

• The library isn't designed to work with React however we can make it work if we ignore a bit of the best React practices; will result in a bit of performance hit.