Skip to content

Repository files navigation

Full House

Last commit License

Full House is intended to become an application for managing household groceries.

Vision

Track what you have at home, monitor best-before dates, and make restocking easy.

What It Should Become

  • Manage groceries and their quantities
  • Record and monitor best-before dates
  • Define a target "always-have" list for your household
  • Quickly see what is missing and what you need to buy to restock

Goal

Help users reduce food waste, avoid stockouts and shop with a clear, practical list.

Current Status

Current implementation is an early foundation and does not yet cover the full grocery-management vision.

  • Server and webclient foundations are in place.
  • Product and stock management basics are implemented.
  • Best-before tracking, household target stock goals, and automated restock suggestions are planned next steps.

Contributing

Contributions are welcome! See CONTRIBUTING.md for how to set up the project locally, run tests, and submit changes.

Deployment

Docker images are published to the GitHub Container Registry on every push to main and on version tags (v*).

Quick start

Copy this example docker-compose.yml and adjust to your needs:

services:
  app:
    image: ghcr.io/nicoviii/full-house:main
    ports:
      - "8000:80"
    volumes:
      - db_data:/data
    environment:
      DATABASE_PATH: /data/full_house.db
      SECRET_KEY_BASE: "replace-with-a-long-random-secret"
    restart: unless-stopped

volumes:
  db_data:

Then start it:

docker compose -f docker-compose.yml up -d

The application is then available at http://localhost:8000.

Environment variables

Variable Default Description
DATABASE_PATH ./db/data/full_house.db Path to the SQLite database file
PORT 8000 (dev) / 80 (Docker) Port the HTTP server listens on
SECRET_KEY_BASE (dev fallback) Secret used for request signing — set this in production
STATIC_DIR ./static Directory from which the frontend assets are served

Image tags

Tag When published
main Every push to the main branch
1.2.3, 1.2, 1, latest When a v1.2.3 git tag is pushed

About

Full House is intended to become a self-hosted application for managing household groceries.

Topics

Resources

Contributing

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages