Portfolio project IDATT1003 - Foodwaste reduction app

STUDENT NAME = "Sigurd Andris Sørengen"

STUDENT ID = "137405"

Project description

This projects was developed as the end assignment used in for the programming course IDATT1003 at NTNU-Trondheim. The FoodWaste app is more or less a utility that helps people keep track of their current food situation (e.g. what food they have at hand), as well as incuding some numerous other features:

The main features of the app are:

• A food storage to keep track of the food the user has at hand
  • The food storage keeps track of how much of each grocery is available, their expiration date & more.
• A cookbook for recipes
  • In the cookbook you can add a recipe for a dish of your choice.
    • The cookbook keeps track of what food you have in the food storage, and can tell you if you can or can't make the dish with the food the user has at hand. This way the program can also make suggestions for what recipes to make.
    • You can choose weather or not to include food that is past it's best before date, further helping in the fight against food waste.

Instances of the GroceryInstance class contain the following information:

• The name of the grocery and the measurement unit most often associated with this type of grocery.
• How much you have of this grocery
• The best before (expiration) date of the given grocery
• The price of the grocery per unit

Instances of the Recipe class contain the following information

• The ingredients of the recipe, including approximations for how much of each to use in the recipe.
• A short description of the recipe
• Instructions for how to make the recipe

Project structure

All source files for classes are stored in src/main/java/edu/ntnu/idi/idatt where they then split up into separate packages. The models package includes the base classes for groceries as well as recipes, the utils package contains UI utilities, mostly used throughout the UserInterface class (used to create all text-based menus), which is stored in views. The main class, here titled 'FoodWasteApp' is stored in the root of the src/main/java/edu/ntnu/idi/idatt directory.

The tests for each of the model classes are stored in src/test/java/edu/ntnu/idi/idatt/models.

How to run the project

1. Go to the releases tab here.
2. Download the .jar file of the latest release.
3. Open a new terminal window in the directory where you saved the .jar file and enter the terminal command java -jar "filename".jar.

How to run the tests

1. Download the source code.
2. Open the source code using any IDE of your choice, where you have configured the project to be a Maven test project.
3. Simply run the test you wish to run!

Project references

General references for theory:

Horstman, C. S. (2024). CoreJava Volume I: Fundamentals Twelfth Edition (12th Edt.). Oracle Press.

References used to implement code:

Oracle. (No year). Class SimpleDateFormat. url: https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html

Oracle. (No year). Class BufferedInputStream. url: https://docs.oracle.com/javase/8/docs/api/java/io/BufferedInputStream.html

Oracle. (No year). Class IOException. url: https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html

Oracle. (No year). Class InputStream. https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html

Oracle. (No year). Class AudioInputStream. url: https://docs.oracle.com/javase/8/docs/api/javax/sound/sampled/AudioInputStream.html

Oracle. (No year). Class AudioSystem. url: https://docs.oracle.com/javase/8/docs/api/javax/sound/sampled/AudioSystem.html

Oracle. (No year). Interface Clip. url: https://docs.oracle.com/javase/8/docs/api/javax/sound/sampled/Clip.html

Oracle. (No year). Class LineUnavailableException. url: https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/sound/sampled/LineUnavailableException.html

Oracle. (No year). Class UnsupportedAudioFileException url: https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/sound/sampled/UnsupportedAudioFileException.html

References for sound resources used in code:

Kondo, K. (1998). Ocarina of Time: Dialog Next Sound. Nintendo. (Retrieved from: http://noproblo.dayjo.org/ZeldaSounds/OOT/index.html)

Atlus Sound Team. (2016). Persona 5: Confirm sound. Atlus. (Retrieved from: https://www.youtube.com/watch?v=XiewSGTFdjA)

Kirkhope, G. (1999). Donkey Kong 64: Donkey Kong "YEAH" Sound Effect. Nintendo. (Retrieved from: https://www.youtube.com/watch?v=cw38yZHOBgA)

Kane. T. (2005). Lego Star Wars: Yoda Death Sound Effect. (Retrieved from: https://www.youtube.com/watch?v=glN0W8WogK8)