/sbking

SBKing is a King card game software aimed to provide a rich and intuitive interface and an online experience to King players. It is still in early development and is licensed under GPL.

Primary LanguageJavaGNU General Public License v3.0GPL-3.0

SBKing - an online King card game

About the project

SBKing is a King card game software aimed to provide a rich and intuitive interface and an online experience to King players. It is still in early development and is licensed as GPL.

Java version

SBKing uses Java 17 in development. Also, the release version for the client is Java 8.

Compiling

SBKing uses Makefile and Maven to build. The following line should be enough:

make server

This should clean your directory, compile, run all tests, package the final .jar at the target/ directory and copy it into ./sbking-server.jar. Use java -jar ./sbking-server.jar to run it.

To compile the client in the same fashion (./sbking-client.jar):

make client

Code quality

You can also run checks to verify the package is valid and meets quality criteria.

mvn verify

This will include JaCoCo's code coverage report at target/site/jacoco/index.html

And you can also see potential bugs with SpotBugs running:

mvn spotbugs:gui

Using Docker

If you prefer to user Docker, you can

make build

to build the server image and

make run

to run the server on the default port.

You can also pull the image directly from the Docker Hub.

If you want to just start the server on the default port:

docker run -p 8080:8080 rulojuka/sbking

On DigitalOcean

Create a docker based droplet and

docker run -p 8080:8080 rulojuka/sbking

Pushing to DockerHub

make deploy

Authors and copyright

Authors:

See file AUTHORS

Copyright information:

See file COPYRIGHT

Full license text:

See file COPYING