tahasafdari / memorygame

Memory Game

Game where you flip cards to find pairs. Made with JavaFX.

By Otto Oksanen, Eetu Soronen, Hasan Safdari & Samu Oksala

Table of Contents

• Getting Started
• About The Project
• Vision
• Builds
• Jenkins
• GitHub Actions
• Javadoc

Getting Started

Compiled Windows builds and Jars for other platforms are available in Releases section.
To build or run the game yourself, use Maven (preferably in IntelliJ).
Note that if you want to build the game yourself, this repo does not contain the database server credentials. They are provided elsewhere.

About The Project

This project was made for Ohjelmistotuotantoprojekti 1 & 2 courses at Metropolia UAS. The project is a simple memory game designed for anyone who wants to improve their memory.

Vision

Our vision was to create a fun memory game that's easily accessible. The game was made to improve the players mental capabilities.

Builds

Windows builds and Jar files are available in the releases section. To build the app yourself, first generate a JAR file with Maven, then run the "build.ps1" file to generate a .msi installer. MacOS and Linux have to run the JAR File (Java 17+ required).

Jenkins

To get tests running through Jenkins, first build and run the Docker image with the following command:

docker build -t moby-dick ./ && docker run -d -p 8083:8080 moby-dick

Then go to localhost:8083 and you should see the Jenkins page.

To get the jenkins password run the following command:

docker exec -it <container id> cat /var/jenkins_home/secrets/initialAdminPassword

Then paste the password to the jenkins page, and you should be able to create an admin account and access the jenkins dashboard.

Create a pipeline job with the Jenkinsfile contents. Remember replace the placeholder environment variables first or the server tests will fail!

Note the surefire reports have no styling by default. This is due to Jenkins security policy. The feature can be disabled by running the following in the Jenkins script console:

System.setProperty("hudson.model.DirectoryBrowserSupport.CSP", "")

Github Actions

Runs every time a pull request is made. You can download the surefire reports from the Actions tab on GitHub. Runs the same unit tests as Jenkins

Javadoc

Javadoc is available here.