WebCheckers

An online Checkers game system built in Java 8 and Spark, a web micro-framework.

Team

• Karthik Iyer
• Emily Wesson
• Gaurav Dev Pant
• Hongda Lin
• Eugene Chang

Prerequisites

• Java 8
• Maven

How to run it

1. Clone the repository and go to the root directory.
2. Execute mvn compile exec:java
3. Open in your browser http://localhost:4567/
4. Start a game and begin playing.

How to test it

The Maven build script provides hooks for run unit tests and generate code coverage reports in HTML.

To run tests on all tiers together do this:

1. Execute mvn clean test jacoco:report
2. Open in your browser the file at PROJECT_HOME/target/site/jacoco/index.html

To run tests on each tier in isolation do this:

1. Execute mvn clean exec:exec@tests-and-coverage
2. To view the Model tier tests open in your browser the file at PROJECT_HOME/target/site/jacoco/model/index.html
3. To view the Application tier tests open in your browser the file at PROJECT_HOME/target/site/jacoco/appl/index.html
4. To view the UI tier tests open in your browser the file at PROJECT_HOME/target/site/jacoco/ui/index.html

How to generate the Design documentation PDF

1. Execute mvn exec:exec@docs
2. The generated PDF will be in PROJECT_HOME/target/ directory

How to archive the project

1. Execute mvn exec:exec@zip
2. The generated zipfile will be in ``PROJECT_HOME/target/` directory

License

MIT License

See LICENSE for details.