diff --git a/GettingStarted.md b/GettingStarted.md new file mode 100644 index 000000000..fe5dc2e4f --- /dev/null +++ b/GettingStarted.md @@ -0,0 +1,46 @@ +# Getting Started +For setup first you need the following things: +- Flutter Version 3.27.1 +- IDE like Android Studio or VS Code with Flutter Plugin installed. + +## Steps to run App +1.⁠ ⁠Clone the repository with Git + +```git clone https://github.com/simonoppowa/OpenNutriTracker.git``` + +2.⁠ ⁠Get Dependencies + +```flutter pub get``` + +3.⁠ ⁠Run Build Runner to generate Files + +```flutter pub run build_runner build``` + +4.⁠ ⁠Run App + +```flutter run lib/main.dart``` + +## Running the Application + +The application can be run on multiple platforms. Here are the commands for each: + +### Web (Chrome) +```bash +flutter run -d chrome +``` + +### iOS +```bash +open -a Simulator +flutter run +``` + +### macOS +```bash +flutter run -d macos +``` + +### Android +```bash +flutter run -d android +``` diff --git a/README.md b/README.md index dc6cdebcf..6af9a5ecc 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,6 @@ - -

## Description @@ -33,7 +31,7 @@ OpenNutriTracker is an open-source mobile application designed to simplify nutri

## Install -[](https://testflight.apple.com/join/j7uKoEDl) +[](https://apps.apple.com/us/app/opennutritracker/id6451490901) [](https://play.google.com/store/apps/details?id=com.opennutritracker.ont.opennutritracker) ## Key Features @@ -51,13 +49,17 @@ See [Data Protection](https://www.iubenda.com/privacy-policy/53501884) - **Open-Source**: OpenNutriTracker is an open-source application ## TODOs -- Add serving sizes to meals +- ~~Add serving sizes to meals~~ - ~~Add Imperial unit support~~ - Add support for Material You themes ## Contribution Contributions to OpenNutriTracker are welcome! If you find any issues or have suggestions for new features, please open an issue or submit a pull request. Make sure to follow the project's code style and guidelines. +## Getting Started +See the [Getting Started](GettingStarted.md) file for more information. + + ## Disclaimer OpenNutriTracker is not a medical application. All data provided is not validated and should be used with caution. Please maintain a healthy lifestyle and consult a professional if you have any problems. Use during illness, pregnancy or lactation is not recommended. diff --git a/ios/Podfile.lock b/ios/Podfile.lock index df99acf65..d8a8cadaf 100644 --- a/ios/Podfile.lock +++ b/ios/Podfile.lock @@ -53,13 +53,13 @@ PODS: - GoogleToolboxForMac/Defines (= 4.2.1) - "GoogleToolboxForMac/NSData+zlib (4.2.1)": - GoogleToolboxForMac/Defines (= 4.2.1) - - GoogleUtilities/Environment (8.0.2): + - GoogleUtilities/Environment (8.1.0): - GoogleUtilities/Privacy - - GoogleUtilities/Logger (8.0.2): + - GoogleUtilities/Logger (8.1.0): - GoogleUtilities/Environment - GoogleUtilities/Privacy - - GoogleUtilities/Privacy (8.0.2) - - GoogleUtilities/UserDefaults (8.0.2): + - GoogleUtilities/Privacy (8.1.0) + - GoogleUtilities/UserDefaults (8.1.0): - GoogleUtilities/Logger - GoogleUtilities/Privacy - GTMSessionFetcher/Core (3.5.0) @@ -97,11 +97,11 @@ PODS: - SDWebImage (5.21.0): - SDWebImage/Core (= 5.21.0) - SDWebImage/Core (5.21.0) - - Sentry/HybridSDK (8.42.0) - - sentry_flutter (8.12.0): + - Sentry/HybridSDK (8.46.0) + - sentry_flutter (8.14.2): - Flutter - FlutterMacOS - - Sentry/HybridSDK (= 8.42.0) + - Sentry/HybridSDK (= 8.46.0) - shared_preferences_foundation (0.0.1): - Flutter - FlutterMacOS @@ -182,7 +182,7 @@ SPEC CHECKSUMS: GoogleDataTransport: aae35b7ea0c09004c3797d53c8c41f66f219d6a7 GoogleMLKit: eff9e23ec1d90ea4157a1ee2e32a4f610c5b3318 GoogleToolboxForMac: d1a2cbf009c453f4d6ded37c105e2f67a32206d8 - GoogleUtilities: 26a3abef001b6533cf678d3eb38fd3f614b7872d + GoogleUtilities: 00c88b9a86066ef77f0da2fab05f65d7768ed8e1 GTMSessionFetcher: 5aea5ba6bd522a239e236100971f10cb71b96ab6 MLImage: 0ad1c5f50edd027672d8b26b0fee78a8b4a0fc56 MLKitBarcodeScanning: 0a3064da0a7f49ac24ceb3cb46a5bc67496facd2 @@ -194,8 +194,8 @@ SPEC CHECKSUMS: path_provider_foundation: 2b6b4c569c0fb62ec74538f866245ac84301af46 PromisesObjC: f5707f49cb48b9636751c5b2e7d227e43fba9f47 SDWebImage: f84b0feeb08d2d11e6a9b843cb06d75ebf5b8868 - Sentry: 38ed8bf38eab5812787274bf591e528074c19e02 - sentry_flutter: 7d1f1df30f3768c411603ed449519bbb90a7d87b + Sentry: da60d980b197a46db0b35ea12cb8f39af48d8854 + sentry_flutter: 2df8b0aab7e4aba81261c230cbea31c82a62dd1b shared_preferences_foundation: fcdcbc04712aee1108ac7fda236f363274528f78 sqflite_darwin: 5a7236e3b501866c1c9befc6771dfd73ffb8702d SwiftyGif: 706c60cf65fa2bc5ee0313beece843c8eb8194d4 diff --git a/pubspec.lock b/pubspec.lock index 1aa6420f6..3d6042592 100644 --- a/pubspec.lock +++ b/pubspec.lock @@ -1014,18 +1014,18 @@ packages: dependency: transitive description: name: sentry - sha256: "576ad83415102ba2060142a6701611abc6e67a55af1d7ab339cedd3ba1b0f84c" + sha256: "599701ca0693a74da361bc780b0752e1abc98226cf5095f6b069648116c896bb" url: "https://pub.dev" source: hosted - version: "8.12.0" + version: "8.14.2" sentry_flutter: dependency: "direct main" description: name: sentry_flutter - sha256: dc3761e8659839cc67a18432d9f12e5531affb7ff68e196dbb56846909b5dfdc + sha256: "5ba2cf40646a77d113b37a07bd69f61bb3ec8a73cbabe5537b05a7c89d2656f8" url: "https://pub.dev" source: hosted - version: "8.12.0" + version: "8.14.2" shared_preferences: dependency: transitive description: diff --git a/pubspec.yaml b/pubspec.yaml index ea4f26b44..1172db1e9 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -68,7 +68,7 @@ dependencies: hive: ^2.2.3 hive_flutter: ^1.1.0 - sentry_flutter: ^8.11.2 + sentry_flutter: ^8.14.2 supabase_flutter: ^2.8.2