This project is a simple React application for managing and displaying live football scores during the World Cup. It allows users to add new games, update scores, and view the overall summary of the games.
- Add new games with home and away teams
- Update scores for each game in progress
- View a summary of all games
- Store game data in localStorage to persist across browser refreshes
- Responsive design using Material-UI
To install the project, follow these steps:
- Clone the repository:
git clone https://github.com/janszarwaryn/live-scoreboard.git
- Change to the project directory:
cd live-scoreboard
- Install dependencies:
npm install
- Start the development server:
npm start
- Open your browser and navigate to http://localhost:3000 to view the application.
-
Add a new game:
- Enter the names of the home and away teams in the respective input fields.
- Click the "Start Game" button to add the game to the "Games in Progress" section.
-
Update scores:
- In the "Games in Progress" section, use the "+" and "-" buttons to increase or decrease the score for each team.
- Scores are automatically updated in the game summary.
-
View game summary:
- The "Game Summary" section displays a list of all games, including the home and away teams, and their respective scores.
-
Finish a game:
- In the "Games in Progress" section, click the "Finish Game" button to remove the game from the list of games in progress.
- The game will still be displayed in the game summary.
-
Browser refresh:
- The application stores game data in localStorage, so your data will persist across browser refreshes.
To run the tests for the project, use the following command:
npm test
This will run the test suite and display the test results in the terminal.
If you'd like to contribute to the project, please submit a pull request with your proposed changes or create an issue detailing the changes you'd like to see. :P