No description
Find a file
2023-12-12 16:40:06 -08:00
flask first working version 🎉 2023-12-11 18:44:38 -08:00
openlayers first working version 🎉 2023-12-11 18:44:38 -08:00
react-native added readme, icons 2023-12-12 16:28:25 -08:00
README.md edited README 2023-12-12 16:40:06 -08:00

Beerbuddy

Beerbuddy logo

Introduction

Beerbuddy is an user-reported price-comparison tool inspired by GasBuddy, that allows the user to compare and update prices for beer at their local stores. It is completely open source, and uses OpenLayers together with React Native to provide a smooth user experience.

Currently, the app is only available for download as an Android APK. Work is being undertaken to release iOS/PWA versions, as well as to get Beerbuddy on various app stores.

Getting Beerbuddy

To get started using Beerbuddy immediately, download the APK release. Or, to compile from source, please use the steps below.

Compilation

To compile this app using EAS Build, navigate to the react-native directory and run eas build -p android --profile [yourprofilename]

Usage

Once the app is downloaded and opened, the user will be brought to the default map screen. This screen is typically centered on the user's location.

  • Stores in the viewable region are represented as pins. Clicking on a pin will open a tooltip showing the stores name, cheapest item and cheapest item price per fluid ounce.

  • Clicking more on the pin will open up that store's page, which includes its name, picture as well as a list of all the store's items.

  • To update an item's price at the store, simply click on the pencil next to the item price and enter the new dollar amount.

  • To add an item to the store, use the green Add button at the bottom of the screen. This will open a new item form which will accept the item information. Once finished, use the green Submit button to have that item added to the store.

  • To add a new store to the map, use the New button at the bottom of the map screen. This will open a new store form which will accept the store information. Please note that the store's default photo can be changed if the placeholder photo is tapped. Once complete, use the green Submit button to have that item added to the store.

  • To search for products, simply tap in the search bar on the main map screen, search for your item and press the Enter key. This will display all products matching the queried name in a 50 mile radius. These results can then be sorted by distance, price, price per fluid ounce and time last updated. Tapping on a product will open the store page for the store carrying the product.

Reporting Bugs

As this is an alpha release, bugs in the app are to be expected. Bug reports are welcomed here.