Open Food Facts iOS app

Note: Xcode's limited Markdown support means this file is best viewed on GitHub. Not seeing this as a formatted file in Xcode? Check out the Build section of the project wiki on GitHub for troubleshooting tips.

What is Open Food Facts? What can I work on ?

Open Food Facts is a food products database made by everyone, for everyone. Open Food Facts on iPhone and iPad has 0,5M users and 1M 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.

Priority roadmap

Display food labels (already assigned)
Show additives evaluation on cards (already ready server side and on Android) #173
Add a mode to compare 2 or more products #153
Add a basic product lists system (to buy, eaten…)

Secondary roadmap

Cache viewed products on-device so that they load fast and regardless of network
Add a food category browser
Add support for the new JSON taxonomy system (multilingual, and data augmentation from Wikipedia/Wikidata)
Add support for cosmetics (Open Beauty Facts) and other products #687 and #160
Use the server-side API to get taxonomized field values

Join the team !

OpenFoodFacts has a Slack chat room where we discuss and support each other, join the #iOS and #iOS-alerts channels. Click here to join.

Current features

Offline barcode scanning
View the details of a product
Search for products
Allergen alert
Internationalised user interface & multilingual products handling (view & data addition)
Product addition & editing (incl. on-the-fly OCR of ingredients and labels, plus integration of the OFF AI)
Image upload
Night mode

Issues

Here are issues and feature requests you can work on:

Search issues

Disable search as you type: it does not work and causes performance issues on the server P1 bug search

Scan issues

Card is completely blank if no name/brand/quantity/image is selected

History issues

Product editing issues

Add a prompt to extract Ingredients when photo is already present

Refactoring issues

Onboarding new users

Add a dynamic changelog

Viewing products

Traces are not translated

Images

Building

Quick & automatic setup

The easiest way to setup the dependencies of the project and generate the Xcode project is to run sh scripts/setup.sh from the top of the repository.

Manual setup

If you prefer to not use the sh scripts/setup.sh script and install the dependencies yourself, follow the instructions below.

We use Carthage for dependency management.

Run carthage bootstrap --platform iOS --cache-builds before opening the project in Xcode.

You can install Carthage with Homebrew:

brew install carthage

To generate the Xcode project run sh scripts/create-project.sh. In order to generate the Xcode project we use XcodeGen.

Carthage resources

New to Carthage? Others have found the following resources helpful:

Fastlane

See the fastlane Readme for a list and description of all lanes: fastlane/README.md

To launch a lane, you must have several env variable set. This can be done by creating a .env file in the fastlane folder, and fill it (see .env.example)

You can install Fastlane with Homebrew:

brew cask install fastlane

Generating screenshots

fastlane snapshot

Roadmap on automatic screenshot generation:

fixing the non translatable scan product button so that the screenshot and the app are fully translated
fixing the Scan screenshot generation, and adding a way to set the background of the barcode scanner with an arbitrary image, per country
fixing History screenshot population with products
Adding the proposed fix to clean the top bar with 100% battery, and a fixed time
Adding fastlane frameit to the Fastlane file, so that we can get versions wrapped in physical devices
fixing Chinese screenshot generation
Ensure we can generate for 1 of (iPhone 11 Pro Max, iPhone 11, iPhone XS Max, iPhone XR), 1 of (iPhone 6s Plus, iPhone 7 Plus, iPhone 8 Plus), 1 of (3rd generation iPad Pro)
Extra: For debugging purposes, it would be great to have other screen resolutions (iPhone 11 Pro, iPhone X, iPhone XS) (iPhone 6, iPhone 6s, iPhone 7, iPhone 8) (iPhone SE) (iPhone 4s)

SwiftLint

We have a script that runs when building the app, it executes SwiftLint to enforce a style and conventions to the code.

You can install SwiftLint with Homebrew:

brew install swiftlint

Sentry

Track crashes

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): translate.openfoodfacts.org

puliaiev/openfoodfacts-ios