Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openfoodfacts/openfoodfacts-ios
Native (Swift) version of Open Food Facts for iOS. Coders & Decoders welcome 🤳🥫 😊
https://github.com/openfoodfacts/openfoodfacts-ios
crowdsourcing food food-additives food-products foodtracker hacktoberfest ios iphone openfoodfacts swift xcode
Last synced: about 1 month ago
JSON representation
Native (Swift) version of Open Food Facts for iOS. Coders & Decoders welcome 🤳🥫 😊
- Host: GitHub
- URL: https://github.com/openfoodfacts/openfoodfacts-ios
- Owner: openfoodfacts
- License: apache-2.0
- Archived: true
- Created: 2016-12-04T18:02:45.000Z (about 8 years ago)
- Default Branch: develop
- Last Pushed: 2023-09-05T11:22:10.000Z (over 1 year ago)
- Last Synced: 2024-10-29T22:38:12.081Z (about 1 month ago)
- Topics: crowdsourcing, food, food-additives, food-products, foodtracker, hacktoberfest, ios, iphone, openfoodfacts, swift, xcode
- Language: Swift
- Homepage: https://ios.openfoodfacts.org
- Size: 56.3 MB
- Stars: 359
- Watchers: 18
- Forks: 159
- Open Issues: 137
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- fucking-open-source-ios-apps - Open Food Facts
- awesome-for-beginners - OpenFoodFacts-iOS - wanted)_ <br> Collaborative, free and open database of food products from around the world. Scan barcode to get info or add a product (Swift)
- fucking-awesome-for-beginners - OpenFoodFacts-iOS - wanted)_ <br> Collaborative, free and open database of food products from around the world. Scan barcode to get info or add a product (Swift)
README
# (Old) Open Food Facts iPhone and iPad app
The new app is located at https://github.com/openfoodfacts/smooth-app. We would like to use some part of this [to create a Swift SDK for Open Food Facts](https://github.com/openfoodfacts/openfoodfacts-swift). Will you help us ?
[](https://travis-ci.org/openfoodfacts/openfoodfacts-ios)
[](http://opensource.box.com/badges)
[](https://translate.openfoodfacts.org)
## What is Open Food Facts? What can I work on ?
[Open Food Facts](https://world.openfoodfacts.org/) is a food products database made by everyone, for everyone.
Open Food Facts on iPhone and iPad has 0,5M users and 1,6M products. Each contribution you make will have a large impact on food transparency worldwide. Finding the right issue or feature will help you have even more more impact. Feel free to ask for feedback on the #android channel before you start work, and to document what you intend to code.
### Features you can work on
- [ ] [What can I work on ?](https://github.com/openfoodfacts/openfoodfacts-ios/issues/912)
## Join the team !
OpenFoodFacts [has a Slack chat room where we discuss and support each other](https://slack.openfoodfacts.org/), join the #iOS and #iOS-alerts channels.
## Current features
- [x] Barcode scanning (including a simple offline mode)
- [x] NOVA, Nutri-Score and Eco-Score display (including in grey if we don't have them yet for the product)
- [x] Ingredient analysis with a simple way to get it if not available
- [x] Product page (needs revamping)
- [x] Search for products based on name
- [x] Allergen alerts (would need to be more discoverable)
- [x] Internationalised user interface & multilingual products handling (view & data addition)
- [x] Product addition & editing (incl. on-the-fly OCR of ingredients and labels, plus integration of the OFF AI)
- [x] Image upload
- [x] Night mode
## Code documentation
[Automatically generated code documentation on the wiki](https://github.com/openfoodfacts/openfoodfacts-ios/wiki/)
## Building
### Quick & automatic setup
The easiest way to setup the dependencies of the project and generate the Xcode project is to run `sh scripts/setup.sh` from the top of the repository, before opening the project in Xcode.
#### Dependency Management - Carthage
We currently use [Carthage](https://github.com/Carthage/Carthage) for dependency management.
New to Carthage? Others have found the following resources helpful:
* [Ray Wenderlich's Carthage Tutorial](https://www.raywenderlich.com/416-carthage-tutorial-getting-started)
* [Chris Mendez's Carthage cheat sheet](https://www.chrisjmendez.com/2016/10/30/carthage-cheat-sheet/)
Before opening the project in Xcode, run
`
brew install carthage
`
`
carthage bootstrap --platform iOS --cache-builds
`
To generate the Xcode project run `sh scripts/create-project.sh`.
In order to generate the Xcode project we use [XcodeGen](https://www.github.com/yonaskolb/XcodeGen).
### Fastlane
See the [fastlane/README.md](fastlane/README.md) for a list and description of all lanes.
To launch a lane, you must have several env variable set. This can be done by creating a `.env` file in the `fastlane` folder, and fill it (see `.env.example`)
You can install [Fastlane](https://github.com/fastlane/fastlane) with Homebrew:
```
brew cask install fastlane
```
#### Generating screenshots
```
fastlane snapshot
```
##### Roadmap on automatic screenshot generation:
* [Our priorities](https://github.com/openfoodfacts/openfoodfacts-ios/issues/913)
* [Configuration file](https://github.com/openfoodfacts/openfoodfacts-ios/blob/01ea37e5247978a52d491181bb7dd2fb384214af/Snapshots/SnapshotConfiguration.swift)
### Style and conventions - SwiftLint
A script runs when building the app that executes SwiftLint to enforce style & conventions to the code.
You can install [SwiftLint](https://github.com/realm/SwiftLint/) with Homebrew:
```
brew install swiftlint
```
### Error reporting - Sentry
[Track crashes](https://sentry.io/organizations/openfoodfacts/issues/?project=5276492)
### Translations
You can [help translate](https://translate.openfoodfacts.org) Open Food Facts (no technical knowledge required, takes a minute to signup).