SmartPantry helps you keep track of your groceries and your shopping list. It is available for free from the Play store.
- Scan barcodes using the camera for quick entry of items
- Manage different locations for your items
- Manage your items expiry dates and quantity remaining
- Get notified when an item is about to expire
Macadamian is excited to release SmartPantry as an open-source project under the Apache 2.0 license, and we strongly encourage contributions to the repository. For more information on how you can contribute, please see the contributing section below.
- Android Studio to build the project
- Device with Android 5.0 or higher
- Note: the app has only been tested on a Nexus 5.
- Clone the repo:
git clone https://github.com/Macadamian/smart-pantry.git - In Android Studio select "Open existing project" and select the
SmartPantryfolder. - Plug in your device, or emulate a compatible device using Genymotion and click the run button to build the app
The folder structure for the source files is as follows:
|--content
|--action
|--controllers
|--database
|--readers
|--repositories
|--tables
|--ui
|--activities
|--adapters
|--fragments
|--receivers
|--utility
|--analytics
|--comparators
|--widgets
All strings are stored in res/values/strings.xml.
There are several testing classes (in progress) included in the project that cover some basic unit tests. To run them, right click on the macadamian.smartpantry.tests package in Android Studio and select "Run All Tests".
We welcome any contributions to the repository, and will make an effort to review Pull Requests frequently.
All bugs are tracked using GitHub's issue tracker, and we request that all patches should address an issue from there.
The following open source libraries were used in the project. Thank you!