README.md

Hunger Games: One-click categorizer for Open Food Facts

Hunger Games is a series of mini-apps that let users contribute data to Open Food Facts, in a rather fun way using React. You are very welcome to write the game you want.

Try it

The production website is available at https://hunger.openfoodfacts.org

Why Hunger Games?

• Because we are sympathetic to Katniss' fight against Panem.
• Open Food Facts generates a lot of photos, and we need to turn them into reliable data about food and cosmetics, at very large scale.
• We process all pictures using top OCR techniques and get a lot of raw text and entities (logos) about the products.
• We then need to let users leverage this data to easily complete products, in a fun way, on their mobiles.

The main goal is: Every Open Food Facts user can annotate products in a few minutes.

Who do I talk to?

• Join us at https://openfoodfacts.slack.com/ in the channel #hunger-games. (Signup at https://slack.openfoodfacts.org/

Requirements:

• Node

Setup:

• Install Node
• Install yarn
• Install libraries: yarn install
• run the project locally yarn dev

Libraries:

• React
• MUI (UI library based on material design)
• Axios (HTTP calls)

APIs:

Open Food Facts APIs and Robotoff

Build

yarn build

Countries list

yarn countries

Generate the JSON file src/assets/countries.json which contains all the countries available on OFF taxonomy. Data are obtained from static.openfoodfacts.org

Taxonomy auto-complete

node update-taxonomy-suggestions.js

Fetch categories and labels taxonomy from OpenFoodFacts static files, and generate JSON files used by the Autocomplete fields.

How to define a dashboard

Go to src/pages/logosValidator/dashboardDefinition.ts. You have two objects to edit:

• LOGOS which contains the logos available in dashboards. Add the logos you need by providing at least tag, label, and logo properties.
• DASHBOARD which for a dashboard associates an array of logos.

How you can help

For developers, you can have a look at good first issues or ask on slack in hunger-games channel.

You can also help by improving translation in your language, Or the wiki page of the project

Weekly meetings (joint with the ML/Robotoff meeting)

• We e-meet Mondays at 17:00 Paris Time (16:00 London Time, 21:30 IST, 08:00 AM PT)
• Video call link: https://meet.google.com/qvv-grzm-gzb
• Join by phone: https://tel.meet/qvv-grzm-gzb?pin=9965177492770
• Add the Event to your Calendar by adding the Open Food Facts community calendar to your calendar
• Weekly Agenda: please add the Agenda items as early as you can. Make sure to check the Agenda items in advance of the meeting, so that we have the most informed discussions possible.
• The meeting will handle Agenda items first, and if time permits, collaborative bug triage.
• We strive to timebox the core of the meeting (decision making) to 30 minutes, with an optional free discussion/live debugging afterwards.
• We take comprehensive notes in the Weekly Agenda of agenda item discussions and of decisions taken.

Contributors