Skip to content

AzulImplementation/AzulApiJava

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AzulApiJava

An API to play Azul board game.

Using the API

Download the jar file from releases.

Execute: java -jar target/azulapi.jar <number of players (from 2 to 4)> --server.port=<port, if not entered 8080 will be used>.

Running the API with Maven

mvn spring-boot:run "-Dspring-boot.run.arguments=<number of players (from 2 to 4)> --server.port=<port, if not entered 8080 will be used>"

or:

mvn package
java -jar target/azulapi.jar <number of players (from 2 to 4) --server.port=<port, if not entered 8080 will be used>>

Functionality

To access the functionality documentation please run the service and visit /swagger-ui/index.html endpoint.

Alternatively read GameController.java, FactoryTakingRequest.java and CenterTakingRequest.java classes which have Swagger documentation.

Running the tests with Maven

mvn test

codecov

License

Please read a LICENSE file.