https://github.com/johnathancrow/shoppinglist

A lightweight shopping list web app that you can self-host with docker.
https://github.com/johnathancrow/shoppinglist

browser docker self-hosted shopping

Last synced: 2 days ago
JSON representation

A lightweight shopping list web app that you can self-host with docker.

• Host: GitHub
• URL: https://github.com/johnathancrow/shoppinglist
• Owner: JohnathanCrow
• License: gpl-3.0
• Created: 2024-11-20T16:56:21.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-12-16T01:52:18.000Z (25 days ago)
• Last Synced: 2024-12-16T02:33:55.666Z (25 days ago)
• Topics: browser, docker, self-hosted, shopping
• Language: TypeScript
• Homepage:
• Size: 189 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Shopping List

![screenshot0](https://github.com/user-attachments/assets/1f89c2b4-cb68-498b-b8de-448ddcc56f5c)

A lightweight shopping list web app that you can self-host with docker. Data is saved locally via your browser, and backups can be exported/imported.

## Installation

#### Docker

```

docker run -d --name shoppinglist -p 3200:80 --restart unless-stopped ghcr.io/johnathancrow/shoppinglist:latest

```

#### Demo

If you want to try it out first, here is a **[demo](http://shoppinglist-preview.netlify.app)**.

## Usage

#### Adding Database Items

- Type an item name and click Add or press Enter (e.g., "Apple")

- Prepend a dash to create a divider (e.g., "-Fruit")

- Append a divider to automatically place the item (e.g., "Apple -Fruit")

#### Managing Database Items

- Drag the left edge of an item to reorder

- Click the + icon to add it to your basket

- Click the pencil icon to edit the item

- Click the x icon to delete the item

#### Managing Basket Items

- Add notes to items using the message icon

- Adjust quantities using the number input

- Remove items by using the x icon

- Export your basket using the clipboard, text, or image icons

- Reset the basket using the bin icon

#### Controls

- Export: Save a backup of your database

- Import: Load a backup of your database

- Reset: Reset all items in your database (caution!)

This usage guide can be found in the info icon beside the app header, alongside a light/dark mode toggle.