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 product database
Open Food Facts is a database of food products with ingredients, allergens, nutritional facts and all the tidbits of information that is available on various 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 (i.e available to everyone). 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!
Weekly meetings
- We e-meet Mondays at 16:00 Paris Time (15:00 London Time, 20:30 IST, 07:00 AM PT)
Video call link: https://meet.google.com/nnw-qswu-hza
- Join by phone: https://tel.meet/nnw-qswu-hza?pin=2111028061202
- Add the Event to your Calendar by adding the Open Food Facts community calendar to your calendar
- Weekly Agenda: 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.
Feature Sprint
- We use feature-based sprints, tracked here
User interface
Mockups on the current design and future plans to discussPriorities
- Top issues
- P1 problems
- P1 candidates
- Please add roadmaps here
How do I get started?
-
Join us on Slack at https://openfoodfacts.slack.com/ in the channels:
#api,#productopener,#dev. -
Developer documentation:
- Server Documentation
- Quick start guide (Docker)
- Developer guide (Docker)
- Developer guide (Gitpod)
- Configuration [TBA]
- Dependencies [TBA]
- Database configuration [TBA]
- How to run tests [TBA]
- Perl modules documentation (POD)
Note: documentation follows the Diátaxis Framework
Contribution guidelines
If you're new to Open-Source, we recommend you to check out 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). In particular, you can help with issues on the new design.
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!
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.