Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/forceu/barcodebuddy
Barcode system for Grocy
https://github.com/forceu/barcodebuddy
addon barcode barcode-buddy erp grocy home ownyourdata self-hosted
Last synced: about 24 hours ago
JSON representation
Barcode system for Grocy
- Host: GitHub
- URL: https://github.com/forceu/barcodebuddy
- Owner: Forceu
- License: agpl-3.0
- Created: 2019-07-11T15:36:25.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-02T20:01:53.000Z (6 months ago)
- Last Synced: 2024-08-10T14:13:56.783Z (3 months ago)
- Topics: addon, barcode, barcode-buddy, erp, grocy, home, ownyourdata, self-hosted
- Language: PHP
- Size: 5.77 MB
- Stars: 422
- Watchers: 14
- Forks: 56
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Barcode Buddy for Grocy
[![Documentation Status](https://readthedocs.org/projects/barcodebuddy-documentation/badge/?version=latest)](https://barcodebuddy-documentation.readthedocs.io/en/latest/?badge=latest)
[![Docker Pulls](https://img.shields.io/docker/pulls/f0rc3/barcodebuddy-docker.svg)](https://hub.docker.com/r/f0rc3/barcodebuddy-docker/)
### Available for:
- Bare Metal
- Android Client ([Play Store](https://play.google.com/store/apps/details?id=de.bulling.barcodebuddyscanner) and [F-Droid](https://f-droid.org/en/packages/de.bulling.barcodebuddyscanner/))
- [Docker](https://github.com/Forceu/barcodebuddy-docker) $\textcolor{red}{\textsf{Attention}}$ *Image name has changed!*
- [Kubernetes](https://git.sr.ht/~johnhamelink/k8s-barcodebuddy) *(Community support only)*
- [Home Assistant](https://github.com/Forceu/barcodebuddy-homeassistant) *(Community support only)*## About
Pass barcodes to Barcode Buddy. If already in the [Grocys](https://github.com/grocy/grocy) system, it will consume/add/open the product there. \
If an unknown barcode is passed, the product name will be looked up and a corresponding product can be chosen in the Web UI. \
Tags can be saved — if a new product contains the tag in the name, the product will be already preselected in the drop-down list.## Prerequisites
Webserver that supports PHP (e.g. NGINX, Apache) or Docker, a [Grocy](https://github.com/grocy/grocy) API key and ideally a barcode scanner or Android device.
## Getting Started
Refer to the [documentation](https://barcodebuddy-documentation.readthedocs.io/en/latest/), on how to install the program. \
Installation can be done in a couple of minutes.### Usage
Barcodes can either be manually added to the programm or the process can be automated by grabbing the input from the scanner.
Refer to the [documentation](https://barcodebuddy-documentation.readthedocs.io/en/latest/), on how to use the program.
##### Reverse Proxies
If you are using a reverse proxy, please make sure to disable caching, see [documentation](https://barcodebuddy-documentation.readthedocs.io/en/latest/setup.html#reverse-proxy)
### Screenshots
![Screenshot of the web ui](https://raw.githubusercontent.com/Forceu/barcodebuddy/master/example/screenshots/FullSite_small.png) ![Screenshot of the screen module](https://github.com/Forceu/barcodebuddy/raw/master/example/screenshots/Screen.gif)## Translations
Help translate the project on [Hosted Weblate](https://hosted.weblate.org/engage/barcode-buddy).
## Acknowledgments
* Bernd Bestel for creating the [Grocy](https://github.com/grocy/grocy) Project
* openfoodfacts.org/upcitemdb.com for providing the barcode lookup API
* [PHP-Auth](https://github.com/delight-im/PHP-Auth)
* [NoSleep.js](https://github.com/richtr/NoSleep.js)
* [SortableJS](https://github.com/SortableJS/Sortable)## License
This project is AGPL3+ licensed — browse the [LICENSE.md](LICENSE.md) file for details
## Donations
As with all Free software, the power is less in the finances and more in the collective efforts. \
I really appreciate every pull request and bugreport offered up by BarcodeBuddy's users, so please keep that stuff coming. \
If however, you're not one for coding/design/documentation, and would like to contribute financially, you can do so with the link below. \
All help is very much appreciated![![paypal](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&[email protected]&lc=US&item_name=BarcodeBuddy&no_note=0&cn=¤cy_code=EUR&bn=PP-DonationsBF:btn_donateCC_LG.gif:NonHosted) [![LiberaPay](https://img.shields.io/badge/Donate-LiberaPay-green.svg)](https://liberapay.com/MBulling/donate)