Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/manuel-rw/grocy-scanner
Your Grocy companion to scan and add products to your stock with a single click.
https://github.com/manuel-rw/grocy-scanner
barcode blazor csharp groceries grocy
Last synced: about 3 hours ago
JSON representation
Your Grocy companion to scan and add products to your stock with a single click.
- Host: GitHub
- URL: https://github.com/manuel-rw/grocy-scanner
- Owner: manuel-rw
- License: gpl-3.0
- Created: 2024-01-24T20:03:06.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-09-04T20:05:51.000Z (29 days ago)
- Last Synced: 2024-09-06T04:38:20.201Z (27 days ago)
- Topics: barcode, blazor, csharp, groceries, grocy
- Language: C#
- Homepage:
- Size: 1.3 MB
- Stars: 20
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## About and Motivation
Scan EAN8 / EAN16 barcodes on your products with a camera (or a barcode reader) and add them to your [Grocy](https://grocy.info) in one click.
This is heavily inspired from [barcodebuddy](https://github.com/Forceu/barcodebuddy).
The key difference is how Grocy Scanner is handling products. It will never ask you to map it to an existing product or manually create it, but create it automatically for you in Grocy or update their stock.
Grocy Scanner uses a list of crowd-sourced and proprietary lists from retailers to lookup barcodes.
It was written to recognize products for the most popular retailers in Switzerland, but may find products from retailers in other countries as well.
It's automatic algorithm analyzes the data and chooses the data with the highest quality.
## Screenshots
## Available Providers
- https://migros.ch
- https://coop.ch
- https://ch.openfoodfacts.org/
## Installation
> [!WARNING]
> The application requires at least one location and quantity unit to be configured.
> Without these the application will throw an error and not work.
### Docker Compose
```yaml
version: '3'
services:
grocy-scanner:
container_name: grocy-scanner
image: ghcr.io/manuel-rw/grocy-scanner:latest
restart: always
environment:
- "Grocy__BaseUrl="
- "Grocy__ApiKey="
ports:
- '7575:80'
```
Application will start on http://your-hostname:7575
### TrueNAS
- Add the TrueCharts catalog: https://truecharts.org/manual/intro
- Search for ``Custom App``in the catalog (not the TrueNAS custom app)
- Click on Install
- Enter ``ghcr.io/manuel-rw/grocy-scanner`` as the repository
- Enter ``latest`` as the container tag
- Scroll to "Extra environment variables"
- Add ``Grocy__BaseUrl`` and set it's value to your Grocy URL
- Add ``Grocy__ApiKey`` and set it to your API token
- Scroll to "Networking and services", select http as the type and enter 80 for both target and port.
- (Optional): Set up ingress
- Scroll to the bottom and click "Install"
## Using a physical Scanner
You can use any generic USB, wireless or 2.4Ghz 1D/2D barcode scanner. These act like a keyboard.
Hence you can use them on any device that has a browser and keyboard support. Most Android phones and tablets have support for physical keyboards.
If you have a wired scanner, you can buy an OTC adapter (micro USB / USB C to USB A) to connect your scanner via USB.
For wireless scanners you have to connect via Bluetooth.
It's also recommended to disable virtual / physical keyboard on the Android device:
## Notes
- Retailers can rate limit or drop your request depending on your country and amount of requests.
Please ensure fair usage of these resources. Grocy Scanner already tries to minimize requests as much as possible.
- This application does and will never support products without EAN8/13 barcode.