Cookbook

Description

This is a cookbook app created for your personal use. You can use it to store and look at your favorite recipes at your convenience. If you are not sure about what meal to cook, you can get recipe suggestions based on what type of meal you want.

Application fundementals

The project uses maven to build and to run. Below is 3 different step-by-step-guides to use Cookbook

Java-version: 17.0.8 Maven-version: 3.9.2

To run in Eclipse che follow this step-by-step:

1. Set up your eclipse che account with an access token
2. Follow Open in Eclipse Che
3. Run mvn clean install from the root project directory (cookbook-folder). This will build the project and run all tests (to skip tests add -DskipTests).
4. Run cd restserver && mvn spring-boot:run to launch spring boot. (or run cd restserver followed by mvn spring-boot:run)
5. Open a new terminal. Run mvn javafx:run -f ui/pom.xml to launch the application (or run cd ui followed by mvn javafx:run)
6. Look in endpoint for the 6080-link and paste it into your preferred browser and add /cookbook at the end
7. Log-in or sign up to create your very own personal cookbook!

To run the application as normal in your IDE follow this step-by-step:

1. Run mvn clean install from the root project directory (cookbook-folder). This will build the project and run all tests (to skip tests add -DskipTests).
2. Run mvn javafx:run -f ui/pom.xml to launch the program (or run cd ui followed by mvn javafx:run)
3. Log-in or sign up to create your very own personal cookbook!

To run the application with jlink and jpackage follow this step-by-step:

For windows you need to first download WiX Toolset. If you use Mac or Linux you can skip ahead to step 4

1. Open PowerShell and run the following command
   Invoke-WebRequest -Uri "https://github.com/wixtoolset/wix3/releases/download/wix3112rtm/wix311.exe" -OutFile "wix311.exe"
2. After the download is complete, run the installer by executing the following command:
   Start-Process -Wait -FilePath ".\wix311.exe"
   This will open the WiX installer. Follow the installation prompts, and make sure to note the installation directory.
3. (Optional) While the installer usually adds WiX to the system PATH automatically, you might want to verify or add it manually. You can do this through the System Properties > Advanced > Environment Variables on Windows.
4. Run mvn clean install from the root project directory (cookbook-folder). This will build the project and run all tests (to skip tests add -DskipTests).
5. Run cd restserver && mvn spring-boot:run to launch spring boot (or run cd restserver followed by mvn spring-boot:run)
6. Open a new terminal. Run cd ui && mvn clean compile javafx:jlink jpackage:jpackage. JLink downloads the project as a .zip-file and JPackage convertes it to an "application". To find the .zip-file look in /ui/target
7. Find the application and open it as you would any other application on your computer.
8. Log-in or sign up to create your very own personal cookbook!

Content

Following is an overview of what each folder contains.
Each module also has their own readme file, which is linked at the bottom of their section.

core

See core

main
Contains the classes for the main functionality of the application, its core
CookBook.java
Ingredient.java
Recipe.java
User.java
UserDataFilehandling.java

test
Contains the respective tests for the core-classes + UserDataFilehandling
CookBookTest.java
IngredientTest.java
RecipeTest.java
UserTest.java
UserDataFilehandlingTest.java

Read more about the core module in README for core module

docs

See docs
Contains the documentation for each release. This starts as a plan, but after each release is completed it will be an overview of our work.

Each release contains screenshots of the updated UIDesign and a README.md with additional information about the application functionality.

release1 - contains UIDesign and UIPrototypes for release 1, UserStories and a README.md that contains the application functionality.

release2 - contains updated UIDesign, error messages, architecture diagramand a descriptive README.md-file for this release.

release3 - contains diagrams, updated UIPrototypes, updated userstories and a README.md for this release.

restserver

main
Contains the classes for the Restserver
CookbookApplication.java
CookbookController.java
CookbookService.java
GsonConfiguration.java

test
Tests the Restserver
CookbookModelApplicationTest.java

Read more about restserver module in README for REST API

ui

main
Contains the classes for the user interface
module-info.java
ui
resources

test
Contains the Controller-tests and setup for the tests to run.
CookbookControllerTest.java
MainAppTest.java
UserControllerTest

Read more about the ui module in README for ui module

Code quality

jacoco - collects and presents the test-coverage grade for each module. Located in /target/site/index.html in each module.
spotbugs- checks for bugs and vulnerabilities.
checkstyle- Superficial checks on code layout and formatting issues to enforce a coding standard

Dependencies

Jacoco: 0.8.10

Checkstyle: 3.3.0

Spotbugs: 3.3.0

Gson: 2.10.1

Springboot: 4.7.20

TestFX: 4.0.16-alpha

JPackage: 1.4.0

Springboot: 2.7.5

Implicit Saving

Our app, Cookbook uses implicit saving to make the user experience as seamless and enjoyable as the users favourite recipe. As soon as you’ve registered as a user, all the recipes you add will automatically be saved together in your personal cookbook. Whenever you log into Cookbook, your recipes will be right there - instantly. No need to look through files and folders.