https://github.com/turiphro/barcode-shopping-list

A shopping list that can be operated with a barcode scanner
https://github.com/turiphro/barcode-shopping-list

albert-heijn barcode barcode-scanner barcode-shopping groceries python shopping-list

Last synced: 6 days ago
JSON representation

A shopping list that can be operated with a barcode scanner

• Host: GitHub
• URL: https://github.com/turiphro/barcode-shopping-list
• Owner: turiphro
• License: mit
• Created: 2020-07-26T09:05:44.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-05-06T20:44:16.000Z (over 1 year ago)
• Last Synced: 2023-05-06T21:46:50.389Z (over 1 year ago)
• Topics: albert-heijn, barcode, barcode-scanner, barcode-shopping, groceries, python, shopping-list
• Language: Python
• Homepage: https://turiphro.nl/projects/barcode-scanner-shopping-list
• Size: 3.56 MB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# barcode-shopping-list

A shopping list that can be operated with a barcode scanner.

## Design

Here's a professional design diagram:

    +------------------------+                                     +-------------------------+

    | Command line interface | ----------------------------------> | REST API                |

    |  (Raspberry Pi + LCD)  |                           --------> | (Python + CSV + Docker) |

    +------------------------+                          /          +-------------------------|

                ^                                      /

                |               +---------------------------+

             barcode            | Web interface             |

             scanner            | (static React page)       |

                                +---------------------------+

## Demo

[![Youtube preview](https://img.youtube.com/vi/31pYClpleRU/0.jpg)](https://www.youtube.com/watch?v=31pYClpleRU)

## Run API + WEB

The API and website can be run on any server. If you want to use the web interface outside of

your home (e.g., in the super market), it'll need to be publicly accessible. There's an

example config for Nginx in `etc/`. Data is saved in CSV files (hey, it's a hack) which are

mount to the host OS.

The barcode lookup API currently supports Albert Heijn and Jumbo products, and plaintext input.

Run:

    docker-compose up

The API runs on port 7000, the static website on port 7001.

Or run with docker directly:

    docker build -t barcodeapi src/api && docker run -it --rm -v $PWD/src/api:/app -p7000:5000 -v $PWD/lists/:/app/lists barcodeapi

    docker run -it --rm -v $PWD/src/web/static:/web -p7001:8080 halverneus/static-file-server

## Run CLI

Run:

    python3 src/cli/barcode_cli.py [--hostname your.url.com --port 7000]

    OR:

    docker build -t barcodecli src/cli

    docker run -it --rm --net host -v $PWD/src/cli:/app barcodecli [--hostname your.url.com --port 7000]

Instructions for installing a raspberry pi with LCD screen:

1. Install Raspberry Pi OS Lite (without GUI)

2. Configure wifi:

   https://www.raspberrypi.org/documentation/configuration/wireless/wireless-cli.md

3. sudo apt update && sudo apt install git python3-pip

3. Checkout this repo in $HOME;

   might want to `ssh-keygen` and add the key to github first;

   git clone ssh://[email protected]/turiphro/barcode-shopping-list

4. Configure LCD screen:

   `./install_rpi.sh`

5. Configure autostart; add the run command from above to your `.profile` or `rc.local` file.