⚡ Shopping List Technical Guide

Shopping List is a real time, multi user inventory and shopping list management platform designed for families. It maintains a centralized Master Pantry of household items and enables collaborative creation and management of active shopping lists.

Shopping List Workflow

Item Activation

• Tapping the + on a Master Pantry item adds it to the Shopping List, displayed at the top of the screen.

Item Completion

• Selecting the checkmark on an active item removes it from the list and returns it to the Master Pantry

Signing In

• Open the Shopping List web page
• Select Sign in with Google and choose your email
• If pre approved, you will be logged in immediately
• If not, your status will show as Pending Approval. You may sign out at this point
• Once approved by an Admin, sign in again

Note: The first person in a family to sign in becomes the Admin and can approve additional members

Shopping List Management

• The Master Pantry serves as the permanent database of recurring household items
• Items are organized by Store, then by Folder
• Enabling Sort Mode reveals item level ordering controls and changes the button label to Sorting Active

Setting Up Stores

• Open the Settings Drawer (gear icon)
• Under Stores, a default store is already created
• Select the pencil icon to rename it
• To add more stores, enter a name in the New store name field and select the + icon
• Return to the main screen by clicking on the Close button

Adding Items

Use the Add/Edit Item panel:

• Enter Item Name
• Select a Store from the dropdown list
• (Optional) Assign a Folder (aisle, cooler, department) Cannot have a "\" in the name.
• When adding a folder, an existing folder can be selected from a dropdown list
• (Optional) Add Quantity or Notes
• Select Save Item

To edit an existing item, locate it in the Master Pantry and click its name

Adding Items to the Shopping LIst

• Open the Master Pantry
• Select a Store
• Click the + icon next to an item to move it to the Shopping List

Completing Items and removing from the Shopping List

Click the ✓ next to an active item to mark it complete and return it to its store in the Master Pantry

Sorting Items

• Open the Settings Drawer
• Select Sorting to enable sort mode
• Return to the list to see up/down arrows next to items
• Use the arrows to reorder items
• Return to the Settings Drawer to disable sorting

Technical Implementation Notes

User Roles & Access

Super Admin

• Create and approve new family lists
• All items below

Admin

• Approves or invites new family members to their list
• The first person in a family to sign in becomes the Admin
• Remove family members from their family list
• All items below

Member

• Can add, edit, delete and select items on their family's list
• Can add, edit and delete stores on their family's list

Pending

• User has signed in but awaits an Admin approval

Toolbox Administrative Tools

Stores

• Create, rename, or delete store categories

Family Access

• Invite new members or approve users in Pending status

Pending Approvals

• Admins can approve users who attempted to sign in, granting them access to the family list

Backup & Restore

• Export the entire family list (stores and items) to a .json file or restore from a previous backup

Theme color

• The theme color is chenged to mirror the system color theme or clicking the Theme button. When pressing the Theme button it rotates between light / dark / system.

Pre Provisioning (Super Admin Only)

Super Admins can onboard new families using the Provisioning Panel:

• Enter the new Admin's email
• Select Auto Create Family List to generate a private list for that family

Creating a App icon on your iPhone

• You can add the Shopping List web page to a icon app on your iPhone by adding it to your Home Screen. It will act just like a native app.
• Here is how to do it in Safari:
  • Open Safari and go to the Shopping List you want to turn into an app.
  • Tap the Share button (the square with an upward-pointing arrow) at the bottom of the screen.
  • Scroll down the menu and tap Add to Home Screen.
  • Name the app "Shopping List" and tap Add in the top-right corner.
• The Shopping List icon will immediately appear on your Home Screen. Just tap it to launch the Shopping List in its own dedicated window.