README.md

Grocery-be

Description

This app is like an inventory for your groceries. You can track your groceries and their expiration dates. You can also add new items to your inventory. When used with food-track-be you can track your food usage and see how much you have left. This app use food-details-integrator-be to retrive additional information about the food like nutritional details.

Features

• Manage items in your inventory
• Track expiration dates
• The application is built in native mode with spring native to improve startup time

Requirements

• PostgreSQL
• food-details-integrator-be (optional)

Installation

Cluster installation

To install the application in a cluster you need to have a running PostgreSQL database. Then you have to create grocery namespace, modify the kustomization.yaml file to match your configuration and run the following command:

kubectl apply -k k8s/overlays/qa

Local installation

To run the application locally with docker. To do so run the following command:

docker run -p 8080:8080 ghcr.io/nico-iaco/grocery-be:latest -e {All the environment variables}

Environment variables

Name	Description	Default value
DB_URL	The host of the database
DB_PORT	The port of the database
DB_USER	The user of the database
DB_PASSWORD	The password of the database
DB_NAME	The name of the database
FOOD_DETAILS_BASE_URL	Base url for food-details-integration-be	http://localhost:8081

Database

The database is created automatically by the application. The database is created with the following tables:

• item
• transaction
• item_transaction_list
• food_detail

This is the schema of the database:

However, here is the DDL for the database:

create table pantry
(
    id          uuid not null
        primary key,
    description varchar(255),
    name        varchar(255)
);

create table item
(
    id        uuid not null
        primary key,
    barcode   varchar(255),
    name      varchar(255),
    user_id   varchar(255),
    vendor    varchar(255),
    pantry_id uuid
        constraint fkiv459qrocp55s73hh0dmtwsmp
            references pantry
);

create table transaction
(
    id                 uuid                       not null
        primary key,
    expiration_date    date,
    price              double precision           not null,
    quantity           double precision           not null,
    unit               varchar(255),
    vendor             varchar(255),
    item_id            uuid
        constraint fk3ibvxnlgyfslk9tm8vfcfqb0f
            references item,
    available_quantity double precision default 0 not null,
    purchase_date      date,
    quantity_std       double precision           not null,
    seller             varchar(255)
);

create table item_transaction_list
(
    item_id             uuid not null
        constraint fka3efk1qwebbyior4d54kreuf7
            references item,
    transaction_list_id uuid not null
        constraint uk_2biy54jvr5xe1ej0eq9kj313d
            unique
        constraint fk3c5txed590yrvt06opdmmc3g2
            references transaction
);


create table food_detail
(
    id                  uuid not null
        primary key,
    item_id             uuid
        constraint fk3ibvxnlgyfslk9tm8vfcfqb0f
            references item,
    generic_name        varchar(255),
    image_nutrition_url varchar(255),
    image_url           varchar(255)
);

create table user_pantry
(
    pantry_id uuid         not null references pantry,
    user_id   varchar(255) not null,
    primary key (pantry_id, user_id)
);