Changes

Jump to navigation Jump to search
Line 8: Line 8:  
== Overview ==
 
== Overview ==
   −
* TASK - Make and insert nice diagram here - assigned to Stéphane
+
High level view of the project components and data flow:
* TASK - Create Software Bill of Materials - assigned to Stéphane
+
 
 +
[[File:Open-food-facts-personalized-search-project-overview.png]]
 +
 
 +
Diagram source: https://vecta.io/app/edit/-M2XyVv8ZoaLNrW-zQoT
 +
 
 +
== Software Bill of Materials ==
 +
 
 +
The project uses these software components:
 +
 
 +
* Server side / backend
 +
** Open Food Facts Product Opener
 +
*** Backend of Open Food Facts, written in Perl: https://github.com/openfoodfacts/openfoodfacts-server
 +
** MongoDB
 +
** Apache 2.4 + mod_perl
 +
** nginx
 +
** Debian 9 (Strech)
 +
* Mobile app
 +
** Flutter + Dart (cross-platform for Android and iOS)
    
== Collaboration ==
 
== Collaboration ==
Line 24: Line 41:       −
=== 1. Ingredients analysis and search features extraction ===
+
=== 1. [[Ingredients analysis and search features extraction]] ===
    
We need to transform the text of ingredients list in local languages to structured data that we can use to determine if a food product is vegetarian, vegan, contains palm oil, etc.
 
We need to transform the text of ingredients list in local languages to structured data that we can use to determine if a food product is vegetarian, vegan, contains palm oil, etc.
Line 40: Line 57:  
* Report with metrics of the achieved improvements for each language
 
* Report with metrics of the achieved improvements for each language
   −
=== 2. Server-side product similarity indexing and search ===
+
=== 2. [[Server-side product indexing and search]] ===
   −
For each product, we will precompute a list of similar products (from the same categories, with similar characteristics or possible uses, and available in the same country).
+
For each product, we will precompute a list of similar products (e.g. from the same categories, with similar characteristics or possible uses, and available in the same country), and create a search API to return generic search results from the server to the mobile app. The mobile app will then be able to personalize the generic search results according to the preferences of the user.
    
==== Milestones ====
 
==== Milestones ====
Line 50: Line 67:  
* Server-side implementation
 
* Server-side implementation
   −
 
+
=== 3. [[Client-side libraries for personalized product filtering and ranking]] ===
=== 3. Client-side libraries for personalized product filtering and ranking ===
      
On device in the mobile app, the generic search results from the server will be filtered and ranked according to the preferences of the user, which will stay on her local machine or phone. We will create an open-source library so that the personalization of results can be implemented in the Open Food Facts app, but also 3rd party apps.
 
On device in the mobile app, the generic search results from the server will be filtered and ranked according to the preferences of the user, which will stay on her local machine or phone. We will create an open-source library so that the personalization of results can be implemented in the Open Food Facts app, but also 3rd party apps.
Line 60: Line 76:  
* Technical specs
 
* Technical specs
 
* Libraries implementation and documentation
 
* Libraries implementation and documentation
      
=== 4. User interface on the Open Food Facts mobile app ===
 
=== 4. User interface on the Open Food Facts mobile app ===
Line 71: Line 86:  
* Working code
 
* Working code
 
* Deployment of feature in mobile app
 
* Deployment of feature in mobile app
 +
 +
== Implementation ==
 +
 +
* Server-side
 +
** Ingredients analysis - done
 +
** [[Open Food Facts Search API Version 2]] - https://github.com/openfoodfacts/openfoodfacts-server/pull/4039 - in progress
 +
** [[Product Attributes]] for ranking - https://github.com/openfoodfacts/openfoodfacts-server/pull/4113 - in progress
 +
* New OFF Flutter app ("Smoothie")
 +
** UI to locally save user preferences - done
 +
** Flutter package to score a product based on locally saved user preferences + product attributes from the API
 +
** UI to display the ranked list of products
 +
** UI to display ranked product attributes for one product
 +
* OFF web site
 +
** UI to locally save user preferences - https://github.com/openfoodfacts/openfoodfacts-server/issues/4119
 +
** Javascript library to score a product based on locally saved user preferences + product attributes from the API - https://github.com/openfoodfacts/openfoodfacts-server/issues/4120
 +
** Local UI to display the ranked list of products according to user preferences (JS based) - https://github.com/openfoodfacts/openfoodfacts-server/issues/4121
 +
** Local UI to display for one product the ranked product attributes according to user preferences (JS based) - https://github.com/openfoodfacts/openfoodfacts-server/issues/4122
       
[[Category:Project:Personalized_Search]]
 
[[Category:Project:Personalized_Search]]

Navigation menu