Skip to content

Commit

Permalink
chore: Add a few comments about macOS development (#4327)
Browse files Browse the repository at this point in the history
  • Loading branch information
g123k committed Jul 17, 2023
1 parent 4e13ebf commit b368f37
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .run/iOS app.run.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="iOS app" type="FlutterRunConfigurationType" factoryName="Flutter" folderName="iOS">
<configuration default="false" name="iOS/macOS app" type="FlutterRunConfigurationType" factoryName="Flutter" folderName="iOS / macOS">
<option name="filePath" value="$PROJECT_DIR$/packages/smooth_app/lib/entrypoints/ios/main_ios.dart" />
<method v="2" />
</configuration>
Expand Down
2 changes: 1 addition & 1 deletion .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"program": "packages/smooth_app/lib/entrypoints/android/main_google_play.dart"
},
{
"name": "iOS",
"name": "iOS/macOS",
"type": "dart",
"request": "launch",
"program": "packages/smooth_app/lib/entrypoints/ios/main_ios.dart"
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ In order to run the application, make sure you are in the `packages/smooth_app`

- `flutter pub get .`
- On Android 🤖: flutter run -t lib/entrypoints/android/main_google_play.dart
- On iOS 🍎: flutter run -t lib/entrypoints/ios/main_ios.dart
- On iOS/macOS 🍎: flutter run -t lib/entrypoints/ios/main_ios.dart

## Contributing

Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,11 @@ Starting this April, we invite all users and contributors to build a vision for

- Smooth-app is developed in parallel to the [openfoodfacts-dart](https://github.com/openfoodfacts/openfoodfacts-dart) plugin, which provides a high level interface with the Open Food Facts API and [openfoodfacts_flutter_lints](https://github.com/openfoodfacts/openfoodfacts_flutter_lints) which provides specific linting
- Every new interaction with the API should be implemented in the plugin in order to provide these new features to other developers.
- We support desktop platforms (Linux, macOS and Windows), but **only for development**

<br>

<details><summary><h2> Features of the app </h2></summary>
<details><summary><h2>Features of the app</h2></summary>

## Features

Expand Down Expand Up @@ -101,7 +102,7 @@ In order to run the application, make sure you are in the `packages/smooth_app`

- On Android 🤖: `flutter run -t lib/entrypoints/android/main_google_play.dart`

- On iOS 🍎: `flutter run -t lib/entrypoints/ios/main_ios.dart`
- On iOS/macOS 🍎: `flutter run -t lib/entrypoints/ios/main_ios.dart`

- Troubleshooting🚀: If you get an error like `App depends on scanner shared from path which depends on camera_platform_interface from git, version solving failed.` then run
- `flutter pub cache clean` or manually delete the
Expand Down
4 changes: 3 additions & 1 deletion packages/smooth_app/lib/entrypoints/ios/main_ios.dart
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ import 'package:smooth_app/main.dart';

/// App Store/TestFlight version with:
/// - Barcode decoding algorithm: MLKit
/// - iOS SDK to open the store
/// - iOS/macOS SDK to open the store
///
/// This version is compatible both with iOS and macOS
void main() {
launchSmoothApp(
barcodeScanner: const ScannerMLKit(),
Expand Down

0 comments on commit b368f37

Please sign in to comment.