Project:Food Rescue: Difference between revisions

From Open Food Facts wiki
(section "Getting started")
No edit summary
Β 
(8 intermediate revisions by one other user not shown)
Line 1: Line 1:
The ''Storage Life Insights'' project is about adding features related to the interpretation of expiry dates to the Open Food Facts mobile applications, server software and web interface. It may also result in additional software for features that don't fit into the official Open Food Facts software.
The ''Food Rescue App'' project is about understanding expiry dates and the behaviour of food as it ages, in order to combat consumer food waste. It will result in additions to the Open Food Facts mobile applications, server software and web interface, but will probably also result in its own mobile application that utilizes barcode and category data from Open Food Facts.


The project receives funding from the German ministry of education and research from 2020-03 to 2020-08. In Germany, the project is known and promoted under the name "Real MHD App", where "MHD" is the typical abbreviation of "Mindesthaltbarkeitsdatum", the German word for best-before date.
This project received funding from the German Ministry of Education and Research between 2020-03 to 2020-08. In Germany, the project is known and promoted under the name "Real MHD App", where "MHD" is the typical abbreviation of "Mindesthaltbarkeitsdatum", the German word for best-before date.


== Getting started ==
== Project Resources ==
As of 2020-03, the project is in the early stages of development. Expect a first usable software product around 2020-06-01.


Overview of project resources:
The project is using external workspaces. Here is the list of links:


* '''[https://realmhd.app/ Project website].''' Focusing on our audience in Germany. Everything there is also contained here in the wiki.
* '''[https://realmhd.app/ Project website].''' Focusing on our audience in Germany. Everything there is also contained here in the wiki.
* '''[https://prototypefund.de/project/die-realmhd-app/ Prototype Fund webpage].''' A short description of our project by our funding agency, in German. (See also: [https://translate.google.com/translate?sl=de&tl=en&u=https%3A%2F%2Fprototypefund.de%2Fproject%2Fdie-realmhd-app%2F auto-translated version].)
* '''[https://prototypefund.de/project/die-realmhd-app/ Prototype Fund webpage].''' A short description of our project by our funding agency, in German. (See also: [https://translate.google.com/translate?sl=de&tl=en&u=https%3A%2F%2Fprototypefund.de%2Fproject%2Fdie-realmhd-app%2F auto-translated version].)
* '''[[Storage Life Insights|Project wiki]].''' ''(This very page and its sub-pages!)'' The project wiki provides the complete technical documentation of the project, collects ideas for further development etc..
* '''[https://dynalist.io/d/To5BNup9nYdPq7QQ3KlYa-mA Project dynalist].''' The central document with the complete technical documentation of the project, feature ideas, the project plan etc.. Publicly viewable, but you need additional permissions to edit.
* '''[https://github.com/tanius/openfoodfacts-storagelifeinsights Git repository].''' Our fork of the Open Food Facts native Android app where we develop this project's software functionality.
* '''[https://github.com/fairdirect/openfoodfacts-androidapp Git repository].''' Our fork of the Open Food Facts native Android app where we develop this project's software functionality.
* '''[https://openfoodfacts.slack.com/archives/C0A1SE6Q7 Slack channel].''' During the project runtime, we communicate mainly in the Open Food Facts slack channel #expirydates. To join, first [https://slack.openfoodfacts.org/ invite yourself] to the Open Food Facts Slack instance, then join that channel.
* '''[https://openfoodfacts.slack.com/archives/C0A1SE6Q7 Slack channel].''' During the project runtime, we communicate mainly in the Open Food Facts slack channel #expirydates. To join, first [https://slack.openfoodfacts.org/ invite yourself] to the Open Food Facts Slack instance, then join that channel.
* '''Team contacts.''' Currently, Matthias Ansorg ([mailto:matthias@ansorgs.de matthias@ansorgs.de]) is the main developer working on this project. He gets some help from others in the open source community, and you're [[Storage Life Insights#Contributing|welcome to contribute]] as well.
* '''Team contacts.''' Currently, Matthias Ansorg ([mailto:matthias@ansorgs.de matthias@ansorgs.de]) is the main developer working on this project. He gets some help from others in the open source community, and you're welcome to contribute as well if you want.
Β 
[[Category:Food waste]]
== Idea and concept ==
See [[Storage Life Insights/Concept|Concept]].
Β 
== Features ==
See Features. [TODO]
Β 
== Software architecture ==
See Architecture. [TODO]
Β 
== Project plan and timeline ==
Roughly, the project is structured along the following milestones between 2020-03-01 and -08-31:
Β 
# '''Definition of requirements.''' In the beginning, it will be decided which information about the storage life of food should be provided via the mobile application. That depends on the practical relevance of the information, on consumer protection regulations and on the details of the cooperation with Open Food Facts.
# '''Data structure agreement with Open Food Facts.''' Since the collected data on the storage life of food should be contributed to the Open Food Facts database, a suitable data structure is agreed on with the Open Food Facts core team. From what we discussed so far, the core team is generally open to this type of data, but details still need to be discussed and agreed.
# '''Implementation of the software.''' The planned program functions are first implemented in a copy ("fork") of the Open Food Facts codebase. We will repeatedly seek the opinions of developers from the Open Food Facts team to facilitate the later integration of our code.
# '''Data research.''' In addition to the implementation of the software, we collect easily available data on the storage life of food items. These should relate to food items that are in widespread use, in order to give the application a high practical value right from the start.
# '''Integration of the software.''' We contribute our code extensions to the official Open Food Facts Android application, their server software and potentially their web frontend.
# '''Data entry.''' All collected data is now added to the database via the official Open Food Facts application. It will be possible to contribute data in multiple languages ​​(including German). The initial data entry within the scope of this project will not necessarily consist of only data in German, since Open Food Facts is a worldwide project with English and French as its main languages.
# '''Implementation for iOS (optional).''' If there is still time available, the same software functions will also be implemented for the Open Food Facts application for Apple iOS devices.
Β 
== Contributing ==
[TODO]
Β 
== Related work ==
[TODO]
<br />__NOINDEX__

Latest revision as of 10:08, 7 August 2024

The Food Rescue App project is about understanding expiry dates and the behaviour of food as it ages, in order to combat consumer food waste. It will result in additions to the Open Food Facts mobile applications, server software and web interface, but will probably also result in its own mobile application that utilizes barcode and category data from Open Food Facts.

This project received funding from the German Ministry of Education and Research between 2020-03 to 2020-08. In Germany, the project is known and promoted under the name "Real MHD App", where "MHD" is the typical abbreviation of "Mindesthaltbarkeitsdatum", the German word for best-before date.

Project Resources

The project is using external workspaces. Here is the list of links:

  • Project website. Focusing on our audience in Germany. Everything there is also contained here in the wiki.
  • Prototype Fund webpage. A short description of our project by our funding agency, in German. (See also: auto-translated version.)
  • Project dynalist. The central document with the complete technical documentation of the project, feature ideas, the project plan etc.. Publicly viewable, but you need additional permissions to edit.
  • Git repository. Our fork of the Open Food Facts native Android app where we develop this project's software functionality.
  • Slack channel. During the project runtime, we communicate mainly in the Open Food Facts slack channel #expirydates. To join, first invite yourself to the Open Food Facts Slack instance, then join that channel.
  • Team contacts. Currently, Matthias Ansorg (matthias@ansorgs.de) is the main developer working on this project. He gets some help from others in the open source community, and you're welcome to contribute as well if you want.