Skip to main content

Application User Guide

The Quartermaster app is the command center for your household provisions. It is available on iOS, Android, and as a Progressive Web App (PWA) in your web browser.

Account Setup & Household Management​

Creating an Account​

  1. Open the app and select Sign Up.
  2. Enter your email address and choose a secure password.
  3. Confirm your registration via the verification email sent to your inbox.

Configuring Your Household​

All data in Quartermaster is organized around a Household. A household allows multiple devices and users (e.g., family members or housemates) to access a single, shared inventory database.

  • Creating a Household: Upon signing up, you will be prompted to create a new Household. Give it a descriptive name (e.g., "The Smith Residence").
  • Inviting Members: Go to Settings -> Household Members and share the invitation code. Other members can enter this code on sign-up to join your shared list.
  • Roles:
    • Super Admin: The household creator (can dissolve the household, transfer ownership, and promote/demote members).
    • Admin: Can add/remove nodes and promote other editors.
    • Editor: Can scan items, edit inventory, and add to the shopping list.
    • Viewer: Read-only access to pantry levels.

Managing Inventory​

The core of the application is the Inventory Dashboard, which displays item names, quantities, categories, and expiration dates.

Adding Items​

  • Barcode Scan: Tap the Camera Icon on the bottom navigation bar. Point your camera at a food barcode. The app will search the product catalog. If matched, it automatically assigns a category (e.g., "Dairy"), an emoji (e.g., 🧀), and sets a default shelf-life expiration.
  • Manual Add: Tap the "+" (Plus) Button at the top right of the dashboard. Type in the item name, choose a category, select its storage location, and set the quantity.

Storage Locations​

You can catalog items into specific virtual storage locations to keep your inventory organized (e.g., "Upstairs Freezer", "Garage Pantry", "Kitchen Refrigerator").

  • Manage custom storage locations under Settings -> Locations.

Smart Features​

Shopping List & Auto-Restock Rules​

When items run out, you can tap the Shopping Cart Icon next to the product to add it to your Shopping List.

  • You can configure Bulk Training Rules in settings to automate cataloging (e.g., mapping a case barcode of standard soup cans to auto-add 12 individual cans to your inventory).

Chef AI Suggestions​

Tap the Chef AI Tab on the bottom navigation bar.

  • What it does: Chef AI queries your actual, active database inventory and uses artificial intelligence to suggest recipes using ingredients you already have.
  • Voice Mode: You can talk directly to Chef AI. Just tap the microphone, describe what you are in the mood for (e.g., "Suggest a quick dinner using my frozen chicken"), and Chef AI will return matching recipes, instructions, and ingredients.

Account Deletion (Danger Zone)​

If you decide to close your account:

  1. Navigate to App Settings.
  2. Scroll to the bottom of the screen.
  3. Tap Delete User Account.
  4. Confirm the warning popup. This will immediately and permanently delete your user profile, personal settings, and delete any associated database records.