Skip to content

Repository files navigation

Stocked

User guide availbile here.

Java 25 Maven Testing Checkstyle

Stocked is a local Java application designed to eliminate the "I forgot I bought this" cycle. It acts as a warehouse tracker for your kitchen, tracking what you have, flagging what is about to expire, and recommending recipes to use up at-risk ingredients.

Developers


Core Features

  • Live Inventory: Visual tracking for your Fridge, Freezer, and Cupboard.
  • Waste-Saver Logic: Automatically recommends recipes based on ingredients that are expiring soon.
  • Privacy First: 100% local data storage using binary files. No cloud, no accounts, no telemetry, no nothing.

Technical Stack

  • Language: Java 25
  • Build Tool: Maven
  • Data Persistence: Java Object Serialization
  • GUI: JavaFX
  • Testing & Quality: JUnit 5, strict Checkstyle enforcement.

Getting Started

Prerequisites

  • JDK 25 or higher installed
  • Apache Maven installed

Installation & Running

  1. Clone the repository:
    git clone [https://github.com/TUe-2IRR00-2026-Group7/Stocked.git](https://github.com/TUe-2IRR00-2026-Group7/Stocked.git)
    cd Stocked
  2. Ensure all checks and linting pass:
    mvn clean validate test
  3. Run the application (JavaFX UI):
    mvn clean compile javafx:run

Testing

The backend data layer (DataManager, FoodCatalogue, etc.) is fully covered by an isolated JUnit testing suite to prevent data corruption and regression.

To run the full test suite and verify build stability, run:

mvn clean test

Documentation & Dev Logs

All Documentation can be found in the docs folder inside this repository.

Review Assignment Due Date

About

A mirror of our group project with us and others. The school made the repository private however the members agreed the code can be public.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages