Nextcloud Pantry

A household management app for Nextcloud — shared checklists, photo boards, and notes, all in one place.

Website & documentation: pantry.casraf.dev

Screenshots

Checklist	Photo Board	Notes Wall

Features

• Houses: Group household members and their shared data. A person can belong to multiple houses and switch between them freely.
• Checklists: Create and manage shared checklists with support for recurring items (e.g. milk every week) that automatically reappear when due.
• Shopping Mode: Turn your lists into a store-by-store trip — pick the lists and the route, check items off as you walk, see which housemates are out shopping, and finish with a priced review that lands in your shopping history.
• Barcode Scanning: Prefill an item from a product's EAN or UPC — scan with the camera or type the code in, and Pantry looks up the name, category and photo for you to review.
• Custom Fields: Attach your own information to checklist items — an expiry date, an aisle number, a size, a yes/no flag — defined once for the house or a single list, with optional reminders on date fields.
• Photo Boards: Keep shared reference photos organized in folders — the right brand of dog food, a favorite recipe card, a product label, and so on.
• Notes Wall: A lightweight shared space for household reminders, pinned messages, and quick notes with customizable colors.
• Notifications: Get notified when household members upload photos, add notes, or edit shared content.
• Modern UI: Built with Vue 3 and Nextcloud Vue components.

Documentation

Full guides and reference live on the Pantry website:

• Documentation home — installing the server app, pairing a client, and using every feature.
• Permissions — how roles and capabilities work, and which action needs which permission.
• Shopping Mode — start a trip, walk your stores, and finish with a priced review.

Companion Apps

Pantry also has companion apps for mobile and desktop that let you manage your lists, photos and notes on the go and keep everything in sync with your Nextcloud instance.

• Android (Google Play)
• Android (F-Droid)
• iOS/macOS (App Store)

The apps collect no analytics and keep your data on your Nextcloud server — see the privacy policy.

The repository for the companion apps is here. If you have issues that are specific to the apps and not the core Nextcloud app, please open an issue there.

Installation

From the Nextcloud App Store

Install Pantry directly from your Nextcloud instance through the Apps page.

Manual Installation

1. Download the latest release from the releases page
2. Extract to your Nextcloud apps directory:

cd /path/to/nextcloud/custom_apps
tar xfv pantry-vX.X.X.tar.gz

3. Enable the app from Nextcloud's Apps page or via command line:

php occ app:enable pantry

Contributing

I am developing this app on my free time, so any support, whether code, issues, or just stars is very helpful to sustaining its life. If you are feeling incredibly generous and would like to donate just a small amount to help sustain this project, I would be very very thankful!

I welcome any issues or pull requests on GitHub. If you find a bug, or would like a new feature, don't hesitate to open an appropriate issue and I will do my best to reply promptly.

Translations

If you're interested in translating this app, please visit the Pantry app resource on Transifex.

For more information about translations, including how to join the Nextcloud project, see Translate Nextcloud.

Translation resources are synced daily and updates are available on the next release of the app after they are synced.

Development

Prerequisites

• pnpm
• Composer (auto-downloaded if missing)
• A running Nextcloud instance (Docker recommended)

Quick Start

make build       # install PHP+JS deps and build
pnpm dev         # start watching for frontend changes
make test        # run PHP tests
pnpm test        # run frontend tests
make lint        # lint JS + PHP

Project Layout

.
├─ appinfo/          # App metadata & registration (info.xml, routes.php)
├─ lib/              # PHP backend (PSR-4: OCA\Pantry\…)
│  ├─ Controller/    # API endpoints
│  ├─ Service/       # Business logic
│  ├─ Db/            # Entities & mappers
│  ├─ Migration/     # Database migrations
│  └─ Notification/  # Notification handlers
├─ src/              # Frontend (Vue 3 + Vite + TypeScript)
│  ├─ components/    # Reusable UI components
│  ├─ views/         # Route views
│  ├─ composables/   # Vue composables
│  └─ api/           # API client layer
├─ tests/            # PHPUnit tests
└─ gen/              # Scaffolding templates (pnpm gen)

License

This app is licensed under the AGPL-3.0-or-later license.