Open Food Facts - Android app
The new Open Food Facts app is located HERE
Note: This codebase is currently only deployed for Open Beauty Facts, Open Pet Food Facts and Open Products Facts apps.
Open Food Facts is collaborative food products database made by everyone, for everyone. Open Food Facts contributors gathers information and data on food products from around the world, using mobile apps.
-
Join the Play Store Beta (rather stable) - Join the Play Store internal build (bleeding edge). You might need communicating your email for whitelisting to teolemon on slack (or pierre at openfoodfacts org).
-
Open Beauty Facts, Open Pet Food Facts and Open Products Facts are also built from this codebase.
What is Open Food Facts?
A food products database
Open Food Facts is a database of food products with ingredients, allergens, nutrition facts… which allow us to compute scores like Nutri-Score, NOVA groups and Eco-Score.
Made by everyone
Open Food Facts is a non-profit association of volunteers. 25000+ contributors like you have added 1,7M+ products from 150 countries using our Android or iPhone apps to scan barcodes and upload pictures of products and their labels.
For everyone
Data about food is of public interest and has to be open. The complete database is published as open data and can be reused by anyone.
User flows
Visual documentation of the App on Figma
Documentation of the source code
The documentation is generated automatically from the source code and your improvements to code documentation are published automatically. Code documentation on GitHub pages
Helping with our next release
Here are issues and feature requests you can work on:
What can I work on ?
Open Food Facts on Android has 0,5M users and 1,6M products. Each contribution you make will have a large impact on food transparency worldwide. Finding the right issue or feature will help you have even more more impact. Feel free to ask for feedback on the #android channel before you start work, and to document what you intend to code.
If you don't have time to contribute code, you're very welcome to
- Scan new products
- Make a donation to help pay for the hosting and general costs
Help translate Open Food Facts in your language
You can help translate Open Food Facts and the app at (no technical knowledge required, takes a minute to signup):
https://translate.openfoodfacts.org
Installation
| Choose the right flavor | Install steps |
|---|---|
 |
* Download the latest Android Studio stable build. * If you are running the app for the first time, Android Studio will ask you to install the Gradle dependencies. * If you are a new contributor to open-source, we recommend you read our Setup Guidelines * In Android Studio, make sure to select OFF as the default flavor for Open Food Facts (OBF is Open Beauty Facts, OPF - Open Products Facts, OPFF - Open Pet Food Facts) * You should be able to install Open Food Facts on your phone using an USB cable, or run it in an emulator. * The package name on the Play Store is org.openfoodfacts.scanner. For historic reasons, it's openfoodfacts.github.scrachx.openfood in the code and on F-Droid. |
Running a Fastlane lane
The project uses Fastlane to automate release and screenshots generation.
- First time you checkout, run
bundle installat the root of the project. - Then launch lanes using
bundle exec fastlane release(for example the release lane). - We're moving Fastlane related things to https://github.com/openfoodfacts/fastlane-descriptions.
Who do I talk to?
- Any member of the Android team or [email protected]
- Join our #android and #android-alerts discussion room on Slack (Get an invite: https://slack.openfoodfacts.org/)
Contributing
If you're new to open-source, we recommend to checkout our Contributing Guidelines. Feel free to fork the project and send a pull request.
Libraries Used
We use the following libraries, and we're not closed to changes where relevant :-)
If you spot any libraries we added or we don't use anymore, feel free to update this list using a Pull Request.
- Dagger 2 - A fast dependency injector for Android and Java
- Retrofit - Retrofit turns your REST API into a Java interface
- OkHttp - An HTTP+SPDY client for Android and Java applications
- Mockito - Most popular Mocking framework for unit tests written in Java
- Apache - The Apache Commons IO library contains utility classes, stream implementations, file filters, file comparators, endian transformation classes, and much more.
- Kotlin Coroutines - A coroutine is a concurrency design pattern that you can use on Android to simplify code that executes asynchronously.
- Hilt - Hilt is a dependency injection library for Android that reduces the boilerplate of doing manual dependency injection in your project.
- Dagger - Manual dependency injection or service locators in an Android app can be problematic depending on the size of your project. You can limit your project's complexity as it scales up by using Dagger to manage dependencies. Dagger automatically generates code that mimics the code you would otherwise have hand-written.
- Jackson - Core part of Jackson that defines Streaming API as well as basic shared abstractions
- journeyapps/zxing-android-embedded - Barcode scanner library for Android, based on the ZXing decoder
- GreenDao
- mikepenz/MaterialDrawer - The flexible, easy to use, all in one drawer library for your Android project.
Big thanks to their contributors!
Copyright and License
Copyright 2016-2022 Open Food Facts
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Contributors
The project was initially started by Scot Scriven, other contributors include: