Develop

.github/workflows/default_workflow.yml

@@ -19,6 +19,7 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+
       - uses: actions/setup-java@v2
         with:
           distribution: 'zulu'
@@ -30,6 +31,9 @@ jobs:
           flutter-version: '3.27.1'
           channel: 'stable'
           cache: true
+
+      - name: Setup Just
+        uses: taiki-e/install-action@just
 
       - name: Cache Flutter packages
         uses: actions/cache@v4
@@ -39,19 +43,10 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pub-cache-
 
-      - name: Install Pub Dependencies
-        run: flutter pub get
-
-      - name: Build with secrets
-        run: flutter pub run build_runner build --delete-conflicting-outputs
-        env:
-          FDC_API_KEY: ${{ secrets.FDC_API_KEY }}
-          SENTRY_DNS: ${{ secrets.SENTRY_DNS }}
-          SUPABASE_PROJECT_ANON_KEY: ${{ secrets.SUPABASE_PROJECT_ANON_KEY }}
-          SUPABASE_PROJECT_URL: ${{ secrets.SUPABASE_PROJECT_URL }}
-
-      - name: Analyze Code
-        run: flutter analyze
-
-      - name: Run Tests
-        run: flutter test
+#      - name: Run CI
+#        run: just ci
+#        env:
+#          FDC_API_KEY: ${{ secrets.FDC_API_KEY }}
+#          SENTRY_DNS: ${{ secrets.SENTRY_DNS }}
+#          SUPABASE_PROJECT_ANON_KEY: ${{ secrets.SUPABASE_PROJECT_ANON_KEY }}
+#          SUPABASE_PROJECT_URL: ${{ secrets.SUPABASE_PROJECT_URL }}

.metadata

@@ -1,26 +1,23 @@
 # This file tracks properties of this Flutter project.
 # Used by Flutter tool to assess capabilities and perform upgrades etc.
 #
-# This file should be version controlled.
+# This file should be version controlled and should not be manually edited.
 
 version:
-  revision: e3c29ec00c9c825c891d75054c63fcc46454dca1
-  channel: stable
+  revision: "35c388afb57ef061d06a39b537336c87e0e3d1b1"
+  channel: "[user-branch]"
 
 project_type: app
 
 # Tracks metadata for the flutter migrate command
 migration:
   platforms:
     - platform: root
-      create_revision: e3c29ec00c9c825c891d75054c63fcc46454dca1
-      base_revision: e3c29ec00c9c825c891d75054c63fcc46454dca1
-    - platform: android
-      create_revision: e3c29ec00c9c825c891d75054c63fcc46454dca1
-      base_revision: e3c29ec00c9c825c891d75054c63fcc46454dca1
-    - platform: ios
-      create_revision: e3c29ec00c9c825c891d75054c63fcc46454dca1
-      base_revision: e3c29ec00c9c825c891d75054c63fcc46454dca1
+      create_revision: 35c388afb57ef061d06a39b537336c87e0e3d1b1
+      base_revision: 35c388afb57ef061d06a39b537336c87e0e3d1b1
+    - platform: web
+      create_revision: 35c388afb57ef061d06a39b537336c87e0e3d1b1
+      base_revision: 35c388afb57ef061d06a39b537336c87e0e3d1b1
 
   # User provided section
 

GettingStarted.md

@@ -1,46 +1,51 @@
-# Getting Started
+# Getting started
+## Android development with Windows 11
+This IDE setup ist tested on Windows 11.
+
 For setup first you need the following things:
-- Flutter Version 3.27.1
+- Android SDK and Android Emulator
+- Flutter
 - IDE like Android Studio or VS Code with Flutter Plugin installed.
 
-## Steps to run App
-1.⁠ ⁠Clone the repository with Git
+Use paths for SDKs without spaces and sepcial characers.
 
-```git clone https://github.com/simonoppowa/OpenNutriTracker.git```
+### Setup Android SDK and Emulator
+1. Download Android Studio from https://developer.android.com/studio and install. Keep "Android Virtual Device" checked. Start Android Studio after installation.
 
-2.⁠ ⁠Get Dependencies
+2. Install the Android SDK when asked.
 
-```flutter pub get```
+3. After finishing the SDK installation you should the "Welcome to Android Studio" Screen. Click on "More Actions" -> "SDK Manager", switch to "SDK Tools" tab and check "Android SDK Command-line Tools (latest)", click "OK" and install the tools. 
 
-3.⁠ ⁠Run Build Runner to generate Files
+4. Check under "More Actions" -> "Virtual Device Manager" if a virtual phone was set up, if not create one, e.g. a Medium Phone with Default Settings.
 
-```flutter pub run build_runner build```
+5. Close Android Studio.
+
+### Setup Flutter SDK
+1. Download Flutter 3.27.1 from https://docs.flutter.dev/install/archive and extract.
+
+2. Add the bin folder in the folder where you extracted Flutter to the Path variable in "Advanced System Settings" -> "Environement Variables..." -> "System variables" -> "Path"
+
+### Setup the Workspace in Visual Studio Code (VSC)
+1. Create a new folder, open the folder in VSC.
 
-4.⁠ ⁠Run App
+2. Configure the Android SDK path for Flutter:
 
-```flutter run lib/main.dart```
+```flutter config --android-sdk "e:\path\to\androidSDK"```
 
-## Running the Application
+3.⁠ ⁠Clone the repository with git in a VSC terminal (make sure the active folder in the terminal is your created folder from step 1):
 
-The application can be run on multiple platforms. Here are the commands for each:
+```git clone https://github.com/simonoppowa/OpenNutriTracker.git .```
 
-### Web (Chrome)
-```bash
-flutter run -d chrome
-```
+4.⁠ ⁠Get Dependencies.
+
+```flutter pub get```
+
+5.⁠ ⁠Run Build Runner to generate Files.
+
+```flutter pub run build_runner build```
 
-### iOS
-```bash
-open -a Simulator
-flutter run
-```
+At the best revert all the visible generated files now, only env.g.dart is needed, it is not checked in because it is in .gitignore.
 
-### macOS
-```bash
-flutter run -d macos
-```
+6.⁠ ⁠Restart VSC, VSC detects now that this is a flutter project. On the Bottom Right "No Device" ist displayed, click on it, then select "Start Medium Phone" on the command Palette on the top. Wait for the phone to boot up.
 
-### Android
-```bash
-flutter run -d android
-```
+7. Press F5 to start a debug session (may taka a while on the first time). Keep the virtual phone running all the time, just start and stop Debugging.

README.md

@@ -56,9 +56,13 @@ See [Data Protection](https://www.iubenda.com/privacy-policy/53501884)
 ## 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.
+Thanks to all the contributors:
+<a href="https://github.com/simonoppowa/OpenNutriTracker/graphs/contributors">
+<img src="https://contrib.rocks/image?repo=simonoppowa/OpenNutriTracker" />
+</a>
 
+### Getting Started With Development
+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.
@@ -78,4 +82,4 @@ For questions, suggestions, or collaborations, feel free to contact the project
 Simon Oppowa
 
 - GitHub: [@simonoppowa](https://github.com/simonoppowa)
-- Email: [opennutritracker-dev@pm.me](mailto:opennutritracker-dev@pm.me)
+- Email: [opennutritracker-dev@pm.me](mailto:opennutritracker-dev@pm.me)

analysis_options.yaml

@@ -9,6 +9,12 @@
 # packages, and plugins designed to encourage good coding practices.
 include: package:flutter_lints/flutter.yaml
 
+analyzer:
+  # generated files throw `unnecessary_string_escapes` lint so we ignore warnings.
+  # TODO: inject `ignore_for_file` as described below.
+  exclude:
+    - lib/generated/intl/*.dart
+
 linter:
   # The lint rules applied to this project can be customized in the
   # section below to disable rules from the `package:flutter_lints/flutter.yaml`

justfile

@@ -0,0 +1,29 @@
+intl_output_dir := "./lib/generated/intl/"
+
+# Install dependencies
+install:
+  flutter pub get
+
+# Build OpenNutriTracker
+build:
+  flutter pub run build_runner build --delete-conflicting-outputs
+
+# Format dart code
+format *OPTIONS:
+  dart format {{OPTIONS}} ./lib ./test
+
+# Regenerate intl files
+run_intl: && format
+  dart run intl_translation:generate_from_arb --output-dir {{intl_output_dir}} lib/**/*.dart ./lib/l10n/*.arb
+
+# Check if intl files are correctly generated
+check_intl: run_intl 
+  git diff  --exit-code {{intl_output_dir}}
+
+# Run tests
+test:
+  flutter test
+
+# Run CI checks
+ci: install (format "--set-exit-if-changed") check_intl build && test
+  flutter analyze

lib/core/data/data_source/config_data_source.dart

@@ -23,16 +23,19 @@ class ConfigDataSource {
 
   Future<void> setConfigDisclaimer(bool hasAcceptedDisclaimer) async {
     _log.fine(
-        'Updating config hasAcceptedDisclaimer to $hasAcceptedDisclaimer');
+      'Updating config hasAcceptedDisclaimer to $hasAcceptedDisclaimer',
+    );
     final config = _configBox.get(_configKey);
     config?.hasAcceptedDisclaimer = hasAcceptedDisclaimer;
     config?.save();
   }
 
   Future<void> setConfigAcceptedAnonymousData(
-      bool hasAcceptedAnonymousData) async {
+    bool hasAcceptedAnonymousData,
+  ) async {
     _log.fine(
-        'Updating config hasAcceptedAnonymousData to $hasAcceptedAnonymousData');
+      'Updating config hasAcceptedAnonymousData to $hasAcceptedAnonymousData',
+    );
     final config = _configBox.get(_configKey);
     config?.hasAcceptedSendAnonymousData = hasAcceptedAnonymousData;
     config?.save();

lib/core/data/data_source/intake_data_source.dart

@@ -23,19 +23,24 @@ class IntakeDataSource {
 
   Future<void> deleteIntakeFromId(String intakeId) async {
     log.fine('Deleting intake item from db');
-    _intakeBox.values
-        .where((dbo) => dbo.id == intakeId)
-        .toList()
-        .forEach((element) {
+    _intakeBox.values.where((dbo) => dbo.id == intakeId).toList().forEach((
+      element,
+    ) {
       element.delete();
     });
   }
 
-  Future<IntakeDBO?> updateIntake(String intakeId, Map<String, dynamic> fields) async {
-    log.fine('Updating intake $intakeId with fields ${fields.toString()} in db');
+  Future<IntakeDBO?> updateIntake(
+    String intakeId,
+    Map<String, dynamic> fields,
+  ) async {
+    log.fine(
+      'Updating intake $intakeId with fields ${fields.toString()} in db',
+    );
     var intakeObject = _intakeBox.values.indexed
-      .where((indexedDbo) => indexedDbo.$2.id == intakeId).firstOrNull;
-    if(intakeObject == null) {
+        .where((indexedDbo) => indexedDbo.$2.id == intakeId)
+        .firstOrNull;
+    if (intakeObject == null) {
       log.fine('Cannot update intake $intakeId as it is non existent');
       return null;
     }
@@ -46,7 +51,7 @@ class IntakeDataSource {
 
   Future<IntakeDBO?> getIntakeById(String intakeId) async {
     return _intakeBox.values.firstWhereOrNull(
-            (intake) => intake.id == intakeId
+      (intake) => intake.id == intakeId,
     );
   }
 
@@ -55,25 +60,30 @@ class IntakeDataSource {
   }
 
   Future<List<IntakeDBO>> getAllIntakesByDate(
-      IntakeTypeDBO intakeType, DateTime dateTime) async {
+    IntakeTypeDBO intakeType,
+    DateTime dateTime,
+  ) async {
     return _intakeBox.values
-        .where((intake) =>
-            DateUtils.isSameDay(dateTime, intake.dateTime) &&
-            intake.type == intakeType)
+        .where(
+          (intake) =>
+              DateUtils.isSameDay(dateTime, intake.dateTime) &&
+              intake.type == intakeType,
+        )
         .toList();
   }
 
-  Future<List<IntakeDBO>> getRecentlyAddedIntake({int number = 100}) async {
+  Future<List<IntakeDBO>> getRecentlyAddedIntake({int number = 100000}) async {
     final intakeList = _intakeBox.values.toList();
 
     //  sort list by date (newest first) and filter unique intake
-    intakeList
-        .sort((a, b) =>  (-1) * a.dateTime.compareTo(b.dateTime));
+    intakeList.sort((a, b) => (-1) * a.dateTime.compareTo(b.dateTime));
 
     final filterCodes = <String>{};
     final uniqueIntake = intakeList
-        .where((intake) =>
-            filterCodes.add(intake.meal.code ?? intake.meal.name ?? ""))
+        .where(
+          (intake) =>
+              filterCodes.add(intake.meal.code ?? intake.meal.name ?? ""),
+        )
         .toList();
 
     return uniqueIntake.take(number).toList();