Taxonomy Editor - Project planning

[teolemon]

What

Preparation

Beta Give feedback

1. Brainstorm on the tech stack of the project
2. Read documentation for the different related projects in Open Food Facts and understand how taxonomies work in Product Opener

Backend

Beta Give feedback

1. Create a basic backend for Taxonomy Editor with functionality for parsing taxonomies
2. Implement CRUD of elements within a taxonomy at the backend

Frontend

Beta Give feedback

1. Build a basic UI for CRUD operations on elements

Search

Beta Give feedback

1. Research on different ways of implementing fast search, using algorithms such as Bayer-Moore or other relevant libraries
2. Some off the shelf solution instead ?
3. Work on implementing fast search functionality for a component in the backend
4. Integrate backend fast search implementation with the frontend
5. Create a backend for parsing taxonomies
6. Provision for quick search of an component
7. Implement CRUD of elements in a taxonomy
8. Research and experiment with different tools for visualization of DAG’s
9. Alex and Charles’ idea for visualization (Forum post: https://forum.openfoodfacts.org/t/taxonomy-editor-gsoc-2022/90/4)
10. Focused on one selected component
11. Visualize ancestors and descendants (only for the selected entry)
12. Navigation through search
13. Options:
14. react-d3-dag (https://github.com/forivall/react-d3-dag)
15. XFlow (https://github.com/antvis/XFlow)
16. Build the basic frontend and backend for displaying the visualization of a taxonomy and its components
17. Create of dynamic visualization of taxonomies during CRUD operations
18. Implement a validation process for modifications done on taxonomies

Wikidata integration

Beta Give feedback

1. Get familiar with the Wikidata JSON API
2. Implement READ operations to add a property from linked Wikidata entity on an existing taxonomy entry
3. Implement READ operation to create a brand new taxonomy entry from a Wikidata entity
4. Implement WRITE operation to write the Open Food Facts linked taxonomy entry on a item on Wikidata

Add features useful for translators

Beta Give feedback

1. Add an integration with a translation API to generate translation suggestions

Rights and Auth management ?

Beta Give feedback

1. Rights and Auth management ?
2. Translators, Editors…

Tasks

Beta Give feedback

1. Test the application and review of test results
2. Work on the documentation of the project
3. Review with mentors for any minor changes
4. Build hierarchy visualizations for taxonomies
5. Implement validation of a taxonomy modification

Why