Line 4: |
Line 4: |
| | | |
| * for an introduction on how to candidate, '''read https://world.openfoodfacts.org/google-summer-of-code''' | | * for an introduction on how to candidate, '''read https://world.openfoodfacts.org/google-summer-of-code''' |
− | * take also the time to visit [https://world.openfoodfacts.org our website] to understand the project more in depth | + | * take also the time to visit [https://world.openfoodfacts.org our website] to understand the project more in depth. |
| | | |
| == Server-side == | | == Server-side == |
| | | |
| === Make the API re-user centric === | | === Make the API re-user centric === |
| + | '''Description''' |
| | | |
| + | The Open Food Facts API is used by a wide variety of applications (more than 200 of them) helping people making better choice around food. |
| + | |
| + | It has grown organically with time, on a volunteer bases, and is sometime messy and complicated to understand. This is a barrier to re-use and does make every one loose time. |
| + | |
| + | '''Expected outcomes''' |
| + | |
| + | Propose a new API, limited to most important items, that is Open API compatible, well designed and easy to understand. |
| + | |
| + | Project implementation could be in two ways: either add a module to Product Opener to transform data to fit the new API (in perl), or either create a proxy in front of current API. |
| + | |
| + | The project will be deployed as soon as possible and iteratively provides a more complete API. |
| + | |
| + | Along the way, the current API documentation should be improved, and a full Open API compliant specification for the new API must be written. |
| + | |
| + | '''Project information''' |
| + | *repository: https://github.com/openfoodfacts/openfoodfacts-server/ |
| + | *Slack channels: #productopener |
| + | *Potential mentors: Stéphane, Alex |
| + | *Project duration: 350 hours |
| + | *Skills required: Perl (at least a minimal understanding), Python or Javascript (for the proxy option) |
| + | *Difficulty rating: Medium<span id="improve-our-producer-platform-to-the-next-level"></span> |
| == Mobile-side == | | == Mobile-side == |
| | | |
Line 22: |
Line 44: |
| * Test and benchmark | | * Test and benchmark |
| * Implement the selected model in the application | | * Implement the selected model in the application |
| + | * stretch goal: Complete recognition with suggestions to narrow the choice |
| | | |
| ====Project information==== | | ====Project information==== |