Skip to content

Lanjelin/Handl

Repository files navigation

Handl

Handl

Handl is a shared shopping list for families and couples.

It is:

  • installable as a PWA
  • fast to open on phones
  • simple to share
  • collaborative with live updates
  • online-first, with a small local cache for settings

It is not:

  • an offline-first note app
  • a task manager
  • a general-purpose document editor
  • a multi-user account system
  • a solution to all of your problems

Try it

  • Hosted instance: handl.gn.gy
  • Docker image: ghcr.io/lanjelin/handl:latest

How to use it

  1. Open Handl and create a new list, or join one with a share code.
  2. Share the list code with the other people who should use the list.
  3. Use the list like a simple shopping list:
    • check items off
    • add new items or edit the list
    • remove checked items when done shopping

Top bar

The icons at the top are there to keep the app quiet and compact:

Icon Meaning
cloud_done Connected and in sync
cloud_sync Still syncing changes
cloud_off Disconnected or stale
groups Other people are viewing the same list
edit_note Toggle between checklist and text editor
settings Open local settings

Self-host

Docker run

docker run -d \
  --name handl \
  -p 3000:3000 \
  -v handl-data:/app/data \
  ghcr.io/lanjelin/handl:latest

Docker Compose

services:
  handl:
    image: ghcr.io/lanjelin/handl:latest
    ports:
      - "3000:3000"
    volumes:
      - ./data:/app/data
    env_file:
      - ./data/.env
    restart: unless-stopped

From source

git clone https://github.com/Lanjelin/Handl.git
cd Handl
npm install
npm start

Configuration

Handl reads optional environment variables from ./data/.env when self-hosted.
You can also set them directly in the container or shell environment.
See .env.example for the full set of variables.
For private instances, you can set PASSWORD to require a simple login before the app opens.

Notes

  • Data is stored in SQLite under ./data.
  • /metrics exposes a small operational snapshot for debugging.

About

Handl is a shared shopping list for families and couples.

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors