Skip to content

Latest commit

 

History

History
76 lines (47 loc) · 2.28 KB

README.md

File metadata and controls

76 lines (47 loc) · 2.28 KB
Raw

WebCheckers

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

Team

  • Kevin Hlavaty
  • Corey Urbanke
  • Russell Lee
  • Ray Lorenzo
  • Danny Gardner

Prerequisites

  • Java 8=>11 (Make sure to have correct JAVA_HOME setup in your environment)
  • 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.

Known bugs and disclaimers

(It may be the case that your implementation is not perfect.)

Document any known bug or nuisance. If any shortcomings, make clear what these are and where they are located.

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 a single tier do this:

  1. Execute mvn clean test-compile surefire:test@tier jacoco:report@tier where tier is one of ui, appl, com.webcheckers.model
  2. Open in your browser the file at PROJECT_HOME/target/site/jacoco/{ui, appl, com.webcheckers.model}/index.html

To run tests on all the tiers in isolation do this:

  1. Execute mvn exec:exec@tests-and-coverage
  2. To view the Model tier tests open in your browser the file at PROJECT_HOME/target/site/jacoco/com.webcheckers.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. Note: this command will fail on a clean project without a /target directory. Create the directory first if running after a clean operation without any intervening commands that create the directory, such as compile.
  3. The generated PDF will be in PROJECT_HOME/target/ directory

How to create a zipfile distribution of the source for the project

  1. Execute mvn exec:exec@zip
  2. The distribution zipfile will be in PROJECT_HOME/target/WebCheckers.zip

License

MIT License

See LICENSE for details.