Portfolio project IDATT1003

This file uses Mark Down syntax. For more information see here.

STUDENT NAME = Yazan Zarka
STUDENT ID = 530542

Requirements

Run mvn --version

// Make sure you have the following installed:

• Apache Maven 3.9.8
• Oracle OpenJDK 23

Project description

// Food Management System is a system that is built with scalability in mind. The system is built to manage groceries and recipes. The system is built with the following features:

Project structure

// All modules follow the following structure:

• Module
  • src

    • main

      • java
        • org.ntnu.packageName

    • test

      • java
        • org.ntnu.packageName

// Food Management System is built modular with SOLID principles without Dependency Injection. The system is divided into the following modules:

• Application (Main Module)

  • Main - The main class of the system
  • Menus - A directory containing the menu contexts of the system and commands
  • Commands - A directory containing the commands of the system
  • Core - A directory containing the Bootstrapper and the Application Context
  • Containers - A directory containing the Food Storage Containers of the system.

• Food - Contains the classes for managing food items

• Console - Contains the classes for managing the console input and output

• Unit - Contains SI units

Link to repository

// https://github.com/NTNU-IDI/idatt1003-mappe-2024-yazanzarka1.git

How to fix not digitally signed error

// If you get an error saying that the file is not digitally signed, you can fix it by running the following command in the terminal:

• Open PowerShell as Administrator and change execution policy for the current session.
• run Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
• Run the script again.

How to run the project

// you run the project by running the following command in the terminal: ./BuildAndRun.ps1 Alternatively, you can run the project in IntelliJ IDEA by following these steps:

• Open the Run menu and select Edit Configurations.
• Click the + icon to add a new configuration and select Application.
• Set the Main class to your main class (e.g., edu.ntnu.idi.idatt.application.Main).
• Click OK to save the configuration.
• Click the Run button (green play icon) in the toolbar to run the program.

How to run the tests

// you run the tests by running the following command in the terminal: ./RunTests.ps1

• alternatively, you can run the tests in IntelliJ IDEA by following these steps:
• Open the Maven tool window (View > Tool Windows > Maven).
• Navigate to root module and expand the Lifecycle node.
• Double-click on the test phase to run all tests.

References

• Java Documentation
• Maven Documentation
• JUnit 5 Documentation
• Cay S. Horstmann, core java fundamentals volume 1, 2007
• https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html