zoldikh / openfoodfacts-server

Open Food Facts database and web interface - 🐪🦋 Perl, CSS and JS coders welcome 😊 For helping in Python, see Robotoff

Open Food Facts - Product Opener (Web Server)

Tests

What is Product Opener?

Product Opener is the server software for Open Food Facts and Open Beauty Facts. It is released under the AGPL license and is being developed in Perl, HTML and JavaScript as Free and Open-Source Software.

It works together with Robotoff, Open Food Facts' AI system (in Python, which can also be installed locally) and the Open Food Facts apps (which can work with your local instance after enabling dev mode)

What is Open Food Facts?

A food products database

Open Food Facts is a database of food products with ingredients, allergens, nutrition facts and all the tidbits of information we can find on product labels.

Made by everyone

Open Food Facts is a non-profit association of volunteers. 25.000+ contributors like you have added 1.7 million + products from 150 countries using our Android, iPhone or Windows Phone app or their camera to scan barcodes and upload pictures of products and their labels.

For everyone

Data about food is of public interest and has to be open. The complete database is published as open data and can be reused by anyone and for any use. Check-out the cool reuses or make your own!

• https://world.openfoodfacts.org

Priorities

• Please list priority issues here
• Please add roadmaps here
• P1 problems
• P1 candidates

How do I get started?

• Join us on Slack at https://openfoodfacts.slack.com/ in the channels: #api, #productopener, #dev.
• Developer documentation:
  • Quick start guide (Docker)
  • Developer guide (Docker)
  • Manual installation
  • Configuration [TBA]
  • Dependencies [TBA]
  • Database configuration [TBA]
  • How to run tests [TBA]
• API Documentation

Note: documentation follows the Diátaxis Framework

Contribution guidelines

If you're new to Open-Source, we recommend you to Checkout our Contributing Guidelines. Feel free to fork the project and send us a pull request.

• Writing tests
• Code review
• Other guidelines
• Please add new features to the CHANGELOG.md file before or after merge to make testing easier

Reporting problems or asking for a feature

Have a bug or a feature request? Please search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue. You can ask directly in the discussion room if you're not sure

Translate Open Food Facts in your language

You can help translate the Open Food Facts web version and the app at : https://translate.openfoodfacts.org/ (no technical knowledge required, takes a minute to signup)

Helping with HTML and CSS

We have [templatized] Product Opener, we use Gulp and NPM, but you'll need to run the Product Opener docker to be able to see the result (see the How do I get set up? section).

Who do I talk to?

• Join our discussion room at https://slack.openfoodfacts.org/ Make sure to join the #productopener and #productopener-alerts channels. Stéphane, Pierre, Charles or Hangy will be around to help you get started.

Contributors

This project exists thanks to all the people who contribute.

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

Open Food Facts Personal Search project was funded through the NGI0 Discovery Fund, a fund established by NLnet with financial support from the European Commission's Next Generation Internet programme.