Group gr2325 repository

Open in che
_NB! Che is not compatible with UI tests, so install with:* mvn clean install -Pskip-ui-tests to run in che. See challenges for more details.
_This will also skip the jacoco report for the UI module. Install locally for full testing and full report.*
To run the app with che, navigate to endpoint 6080 in the lower left corner, copy the url, and open the url in a new tab.

To download the program as a desktop application, click here (not for mac).

This project contains the IT1901 project for group 25.

Our application is "WordDetective: Substring Edition". The main objective for our project is to create a fun and intuitive game for learning.

TL;DR

WordDetective is about writing words that contains a certain substring. For example if the category is fruits and the substring is "PL". Then one answer can be Pineapple

Further details about the application is located in the WordDetective README.

Documentation

Releases of WordDetective:

(Release 1) (Release 2) (Release 3)

Description of content

The root directory primarily contains the "docs" folder and the "WordDetective" Folder.
The "docs" folder contains the documentation of the various releases.
The "WordDetective" folder contains the code of the project, and is made up of the following modules: api, core, persistence, types, and ui.
The api module contains the server configuration and various controllers. The controllers hold the API endpoints which are requested by the UI. Once the API controllers receives a request, it delegates the task to the core module.
The core module contains the core logic of the program. Tasks requiring access to persistently stored user information is delegated to the persistence module.
The persistence module accesses the persistent user files to retrieve user information.
The ui module contains files related to the frontend of the application, such as fxml files and their respective java controller files.
The types module contains the "User" class, which is used to store the user persistently, and enums for login and registration, which is used for giving feedback.

Tentative sketch of folder structure

WordDetective
│
├── api
│   │
│   ├── src
│   │   ├── main
│   │   │   ├── java
│   │   │   │   └── api
│   │   │   │       └── controllers
│   │   │   │           └── [API Controller Files]
│   │   │   │
│   │   │   └── resources
│   │   │       └── [Resource File for API for springboot]
│   │   │
│   │   └── test
│   │       └── java
│   │           └── api
│   │               └── [API Test Files]
│   │
│   └── target
│       └── [Compiled Classes and JARs]
│
├── config
│   ├── checkstyle
│   │   └── [Checkstyle Configuration Files]
│   │
│   └── spotbugs
│       └── [SpotBugs Configuration Files]
│
├── core
│   │
│   ├── src
│   │   ├── main
│   │   │    └── java
│   │   │         └── core
│   │   │               └── [Core logic files]
│   │   │
│   │   └── test
│   │       └── java
│   │           └── core
│   │               └── [Test classes for core logic]
│   │
│   └── target
│       └── [Compiled Classes and JARs]
│
├── persistence
│   ├── src
│   │   ├── main
│   │   │   ├── java
│   │   │   │   └── persistence
│   │   │   │       └── [Persistence Classes]
│   │   │   │
│   │   │   └── resources
│   │   │       ├── default_categories
│   │   │       └── users
│   │   │
│   │   └── test
│   │       └── java
│   │           └── persistence
│   │               └── [Persistence Test Classes]
│   │
│   └── target
│       └── [Compiled Classes and JARs]
│
├── types
│   ├── src
│   │   ├── main
│   │   │   ├── java
│   │   │   │   └── types
│   │   │   │       └── [Type Classes]
│   │   │   │
│   │   │   └── resources
│   │   │       └── [Resource Files for Types]
│   │   │
│   │   └── test
│   │       └── java
│   │           └── types
│   │               └── [Type Test Classes]
│   │
│   └── target
│       └── [Compiled Classes and JARs]
│
└── ui
    │
    ├── assets
    │   ├── images
    │   ├── music
    │   └── video
    │
    ├── src
    │   ├── main
    │   │   ├── java
    │   │   │   └── ui
    │   │   │       └── [Controller files and factory files]
    │   │   │
    │   │   └── resources
    │   │       └── [Fxml files]
    │   │
    │   └── test
    │       └── java
    │           └── ui
    │               └── [Ui tests]
    │
    └── target
        └── [Compiled Classes and JARs]

Version Requirements

Java: 17+

JavaFx: 17.0.8

Apache Maven: 3.8.1

Building the project

Clone code
git clone https://gitlab.stud.idi.ntnu.no/it1901/groups-2023/gr2325/gr2325.git
cd gr2325/WordDetective

Download dependencies
locally: mvn clean install

for che: mvn clean install -Pskip-ui-tests

Build backend application
(From WordDetective directory) mvn -f api/pom.xml spring-boot:run To run the REST server.

Running application

Run application
mvn -f ui/pom.xml javafx:run

Running WordDetective test suite

Tests

Run tests
mvn test

Generate jacoco report (The report can be found in target/site/jacoco)
mvn jacoco:report

Quality tests

Run checkstyle test
mvn checkstyle:check

Run spotbugs test
mvn spotbugs:check

Clean project

Clean up downloaded dependencies
mvn clean

Create Desktop application

• mvn -f ui/pom javafx:jlink
  • This will create a folder named "launch_worddetective", and an equivalent zip file in ui/target. Since we have included javafx media for mp4 background video, the "assets" folder in the ui module must be manually added to the runtime image. This is as simple as copying the "assets" folder into the "launch_worddetective" folder, and then update the zip file accordingly.
• mvn -f ui/pom.xml jpackage:jpackage
• change directory to ui/target/dist, and use: start gr2325_WordDetective_SubstringEdition-1.0.0.exe
• Follow the instructions given by the setup wizard.

Creators

- Dag Kristian Andersen
- Mads André Bårnes
- Bengt Andreas Rotheim
- Anders Stubberud