Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openfoodfacts/taxonomy-editor
Taxonomies are at the heart of Open Food Facts data structure - this project provides an editor
https://github.com/openfoodfacts/taxonomy-editor
fastapi hacktoberfest neo4j open-food-facts python reactjs taxonomy
Last synced: about 1 month ago
JSON representation
Taxonomies are at the heart of Open Food Facts data structure - this project provides an editor
- Host: GitHub
- URL: https://github.com/openfoodfacts/taxonomy-editor
- Owner: openfoodfacts
- License: agpl-3.0
- Created: 2022-05-24T16:00:35.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-06T14:55:11.000Z (4 months ago)
- Last Synced: 2024-10-29T22:38:13.565Z (about 2 months ago)
- Topics: fastapi, hacktoberfest, neo4j, open-food-facts, python, reactjs, taxonomy
- Language: Python
- Homepage: https://wiki.openfoodfacts.org/Taxonomy_editor
- Size: 4.72 MB
- Stars: 18
- Watchers: 8
- Forks: 22
- Open Issues: 79
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Taxonomy Editor
[](#backers)
[](#sponsors)
[](http://makeapullrequest.com)
## What is this project about?
TLDR: Taxonomies are at the 🧡 of Open Food Facts data structure. This project provides an user-friendly editor for editing taxonomies easily.
The Open Food Facts database contains a lot of information on food products, such as ingredients, labels, additives etc.
Because food industry evolves and there can be local peculiarities, we always let people freely enter informations (with suggestions) and we structure afterwards. Structured informations can be more easily exploited (for example to compute the Nutri-Score, detect allergens, etc.).
Taxonomy also brings more informations about products (for example, if an ingredient is vegan, a link to other databases like agribalyse or wikidata…).
Hence, taxonomies are at the heart of data structures in the Open Food Facts database and must be maintained properly.
For more information see the [wiki page about Taxonomies](https://wiki.openfoodfacts.org/Global_taxonomies).
Currently a taxonomy in Open Food Facts is a raw text file containing a Directed Acyclic Graph (DAG) where each leaf node has one or more parent nodes.
The [taxonomy files present in Open Food Facts](https://github.com/openfoodfacts/openfoodfacts-server/tree/main/taxonomies) are long to read (ingredients.txt taxonomy alone has around 80000 lines!) and cumbersome to edit by contributors. It's also difficult to have a high level overview of a taxonomy or grasp its structure.
This project aims to provide a web based user-friendly interface for editing taxonomies with ease.
This tool can help a lot:
- enable searching and navigating the taxonomy
- enable anyone to contribute translations and synonyms, thus enriching the taxonomy
- help spot problems in the taxonomy (missing translations, missing paths, etc.), and get useful statistics about it
- provide helpers to assist power contributors in enriching the taxonomy (eg. find corresponding wikidata entry)
- offer an API to the taxonomy for third party applications (complementing the existing API)
## Why is this project appealing?
- Python and ReactJS tech stack (a powerful combo)
- Runs on a easy-to-learn graph database - Neo4J, using which you can do a lot of useful and interesting requests
- not so huge and focused, you can quickly get your hands on it
- it can have a huge impact for Open Food Facts:
- more language support: reaching more countries
- better analysis of ingredients: more allergy detection, potential finer computation of environment scorer
- better classification of products:Â enable product comparisons, environment score computations, etc.
- enabling more taxonomies:Â for example on brands to know food producers
## How to help
Currently we are focusing on bringing the application to a minimum viable product. See [Move to MVP v2](https://github.com/openfoodfacts/taxonomy-editor/issues/167).
A typescript migration is in progress, and we are also trying to simplify the API as well.
- [GitHub Project](https://github.com/orgs/openfoodfacts/projects/28/views/1) Â
- [Meeting Notes](https://docs.google.com/document/d/1tdYkUmoRU8BxFPdCwtewoUi7PV8PmDlXtExOcPYyu-I/edit#)
Weekly meetings
- We e-meet [Thursdays at 09:00 Paris Time](https://dateful.com/convert/paris-france?t=9am) weekly.
-  Video call link: https://meet.google.com/kdq-mkqd-jrm
- Add the Event to your Calendar by [adding the Open Food Facts community calendar to your calendar](https://wiki.openfoodfacts.org/Events)
- [Agenda](https://docs.google.com/document/d/1tdYkUmoRU8BxFPdCwtewoUi7PV8PmDlXtExOcPYyu-I): 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.
## Getting Started
- Join us on Slack at https://openfoodfacts.slack.com/ in the channel `#taxonomy-editor`.
- Get an invite to our organization using https://slack.openfoodfacts.org/
- Check out the Taxonomy Editor in our pre-production environment:
- The UI: https://ui.taxonomy.openfoodfacts.net/
- The API: https://api.taxonomy.openfoodfacts.net/
- Developer documentation:
- [Setup a dev environment](./doc/introduction/setup-dev.md)
- [Docker Compose Setup](./doc/how-to-guides/docker-compose-setup.md)
- [Contributing Guidelines](./CONTRIBUTING.md)
- Translate: Use [Crowdin](https://crowdin.com/project/openfoodfacts), project Open Food Facts.
- Visit [this link](https://github.com/openfoodfacts/taxonomy-editor/issues) to report issues, give feature requests etc.
## Documentation
Please visit the [doc folder](./doc) for more documentation about the Taxonomy Editor.
This documentation tries to follow as much as possible the documentation system from [Diataxis](https://diataxis.fr/).
## User interface
Screenshots
- [ Mockups on the current design and future plans to discuss](https://www.figma.com/file/7QxD2pOnVntjDPqbHHPGHv/Taxonomy-Editor?t=4YadI2GgSAXcPnlo-0)
## Contributors
