https://github.com/rezaep/rock-scissors-paper
A repository containing Rock-Scissor-Paper project.
https://github.com/rezaep/rock-scissors-paper
docker java junit junit5 maven
Last synced: 3 days ago
JSON representation
A repository containing Rock-Scissor-Paper project.
- Host: GitHub
- URL: https://github.com/rezaep/rock-scissors-paper
- Owner: rezaep
- License: gpl-3.0
- Created: 2019-01-11T07:02:06.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-01-13T20:13:39.000Z (over 6 years ago)
- Last Synced: 2025-01-25T00:17:00.908Z (5 months ago)
- Topics: docker, java, junit, junit5, maven
- Language: Java
- Size: 41 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rock-Scissors-Paper [](https://travis-ci.com/rezaep/Rock-Scissors-Paper) [](https://coveralls.io/github/rezaep/Rock-Scissors-Paper?branch=master) [](https://www.codacy.com/app/rezaep/Rock-Scissors-Paper?utm_source=github.com&utm_medium=referral&utm_content=rezaep/Rock-Scissors-Paper&utm_campaign=Badge_Grade)
A repository containing Rock-Scissor-Paper project.
>Rock-scissors-paper is a zero-sum hand game usually played between two people, in which each player simultaneously forms one of three shapes with an outstretched hand.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Prerequisites
What things you need to run the project
```
Java Development Kit (JDK 8+)
Maven
Docker (if you want to run the project using Docker image)
```
### Installing
```
Clone the repository
git clone https://github.com/rezaep/Rock-Scissors-Paper.git
```
```
Use Maven build tool to build the project. This command runs tests and builds a Jar file.
mvn clean test package
```
```
Run jar file using Java command.
java -jar target/rock-scissors-paper-1.0-SNAPSHOT.jar
```
The example output will be:
```
Player A wins 36 of 100 games
Player B wins 32 of 100 games
Tie: 32 of 100 games
Winner is: Player A (36 to 32 wins)
```
## Running the tests
In order to run automated tests use below command.
```
mvn clean test
```
## Deployment
To package the Jar file inside a Docker image use following commands.
```
mvn clean test package
docker build -t image:tag . (e.g. rezaep/rock-scissors-paper:latest)
```
## Authors
* **Reza Ebrahimpour** - [Github](https://github.com/rezaep)
## License
This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details