Skip to content

lacernakate/cooked

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 

Repository files navigation

Cooked

Cooked is a pantry and recipe tracking application that allows you to add, view, edit, delete, and search the contents of your pantry and collection of recipes. It's designed with a 3-tier architecture, separating the presentation, business logic, and persistence layers. This separation makes the app modular and maintainable, as well as allowing you to easily swap components like the UI or database without impacting other parts of the system.

Features

  • Add Pantry Item: Add ingredient (from pre-populated list in our db) to pantry with a numerical amount.
  • Edit Pantry Item: Edit an existing pantry item's amount.
  • Delete Pantry Item: Remove an ingredient from the pantry.
  • Add Recipe: Add a recipe with a title, description, instructions and list of ingredients.
  • Delete Recipe: Delete recipe from the database.
  • Search: Filter recipes and pantry items by title keywords (case-insensitive).
  • Remove pantry contents based on recipe: Remove the amount of each ingredient present in the recipe from your pantry.
  • Search for recipe by ingredient: Add ingredients as tags in a search bar and a list of recipes with those ingredients get returned

Dependencies & Versions

  • Java: JDK 21.0.6 (or a compatible version)
  • Gradle: Gradle 8.8 (or similar version)
  • SQLite JDBC: org.xerial:sqlite-jdbc:3.36.0.3
    (Provides the SQLite driver for embedded database support)
  • JUnit 5: For unit and integration testing
  • Mockito 5.2: For unit and integration testing

Running the Application

To run the application using Gradle, cd into the cooked directory and use:

./gradlew run

(Alternatively, run your main class via your IDE’s run configuration.)

3-Tier Architecture

See the Architecture Description file for an understanding of the project structure.

Vision Statement

To see the Cooked vision statement view the Vision Statement file.

Retrospective

To view our iteration 3 team retrospective please see the Retrospective file.

Summary

Cooked is a simple recipe/pantry tracking application built on a 3-tier architecture. It leverages SQLite for local data persistence, with a clean separation between UI, business logic, and persistence.

For any further questions or contributions, please refer to the project documentation or contact the development team.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors