Skip to content

Latest commit

 

History

History
144 lines (97 loc) · 8.86 KB

README.md

File metadata and controls

144 lines (97 loc) · 8.86 KB
Raw

Open Food Facts - Android application

A food products database

Open Food Facts is a food products database made by everyone, for everyone. Open Food Facts gathers information and data on food products from around the world.

Project Status Build Status Quality Gate Average time to resolve an issue Percentage of issues still open Crowdin Open Source Helpers

What is Open Food Facts?

A food products database

Open Food Facts is a database of food products with ingredients, allergens, nutrition facts and all the tidbits of information we can find on product labels.

Made by everyone

Open Food Facts is a non-profit association of volunteers. 25000+ contributors like you have added 968000+ products from 150 countries using our Android, iPhone or Windows Phone app or their camera 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 and for any use. Check-out the cool reuses or make your own!

Open Food Facts on Google Play

Open Food Facts on F-Droid

Screenshots

Translations

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

Screenshot generation

To generate basic screenshots of the app on your local computer, launch the command gradlew connectedOffScreenshotsAndroidTest --stacktrace --info -PtestBuildType=screenshots

Bugs and feature requests

Have a bug or a feature request? Please search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Installation

  • Android Studio should be the latest stable build.

  • If you're running the app for the first time, Android Studio will ask you to install the Gradle dependencies.

  • If you're a new contributor to open-source, we recommend you read our Setup Guidelines

  • Select 'OFF' as the flavor (OBF is Open Beauty Facts, OPF: Open Products Facts, OPFF: Open Pet Food Facts)

Libraries Used

We use the following libraries, and we're not closed to changes where relevant :-)

  • 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
  • Butterknife - View "injection" library for Android
  • 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.
  • RxJava - Reactive Extensions for the JVM – a library for composing asynchronous and event-based programs using observable sequences for the Java VM.
  • android-async-http - A Callback-Based Http Client Library for Android
  • Jackson - Core part of Jackson that defines Streaming API as well as basic shared abstractions
  • code-mc/loadtoast - Pretty material design toasts with feedback animations
  • journeyapps/zxing-android-embedded - Barcode scanner library for Android, based on the ZXing decoder
  • koush/ion - Android Asynchronous Networking and Image Loading
  • jsoup - jsoup is a Java library for working with real-world HTML
  • satyan/sugar - Insanely easy way to work with Android Database.
  • afollestad/material-dialogs - A beautiful, fluid, and extensible dialogs API for Kotlin & Android.
  • jjhesk/LoyalNativeSlider - Possible a dynamic viewpager ever you can find.
  • mikepenz/MaterialDrawer - The flexible, easy to use, all in one drawer library for your Android project.

Big thanks to their contributors!

Contributing

The project was initially started by Scot Scriven, other contributors include:

Who do I talk to?

Will you join us ?

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.

Here's a few list of bugs:

If you don't have time to contribute code, you're very welcome to scan new products, or make a donation to help pay for the hosting and general costs

Copyright and License

Copyright 2016-2019 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.