Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/houarizegai/tennis

Basic Tennis Game (Kata)
https://github.com/houarizegai/tennis

java kata react spring-boot tdd

Last synced: 3 months ago
JSON representation

Basic Tennis Game (Kata)

Awesome Lists containing this project

README

        

# Tennis Game
Tennis Game Kata implementation.
Find more about each folder by clicking on the folder name (read the README inside each folder):

| **Apps** | **Description** |
| :----------: | :-------------: |
| [Api](./api) | Backend REST API |
| [Web](./web) | Frontend App |

## Get Started
### Perquisites
Make sure you have:
- [Git](https://git-scm.com/)
- [Docker](https://www.docker.com/) (make sure you have installed `docker-compose` with it)

### Run it locally
1. Open terminal and clone the repo:
```shell
git clone https://github.com/2022-DEV1-038/Tennis.git
```
2. Make sure you are in project root:
```shell
cd Tennis
```
3. Build and run the app in containers:
```shell
docker-compose up -d
```
4. Open [http://localhost:3000](http://localhost:3000) to view the app in your browser.

## User's Manual (How to play)
Find below description of the important elements of the user interface:

| Page | Description |
|:------:|:---------:|
| ![init game](docs/screenshots/init-game.jpg) | 1. Type players name
2. Click Start Game to enter into the game board and start playing |
| ![game board](docs/screenshots/game-board.jpg) | 3. To start a new game
4. Record new points
5. Current players names and their scores
6. Total score |