https://github.com/chromesd22159/bauchglueck

BauchGlück is a specially developed app for people after gastric bypass surgery. It combines nutrition, medication and well-being in an intuitive platform and helps users organize their everyday lives and keep an eye on their health.
https://github.com/chromesd22159/bauchglueck

android firebase jetpack-compose koin kotlin-multiplatform ktor-client room-database swiftui

Last synced: 9 days ago
JSON representation

BauchGlück is a specially developed app for people after gastric bypass surgery. It combines nutrition, medication and well-being in an intuitive platform and helps users organize their everyday lives and keep an eye on their health.

• Host: GitHub
• URL: https://github.com/chromesd22159/bauchglueck
• Owner: ChromeSD22159
• License: apache-2.0
• Created: 2024-07-08T20:27:01.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-10-22T06:27:45.000Z (3 months ago)
• Last Synced: 2024-11-08T18:05:44.842Z (2 months ago)
• Topics: android, firebase, jetpack-compose, koin, kotlin-multiplatform, ktor-client, room-database, swiftui
• Language: Kotlin
• Homepage: https://www.frederikkohler.de/
• Size: 15.2 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        

[![Play Store Badge](./images/play_console_badge_de.svg)](https://play.google.com/store/apps/details?id=de.frederikkohler.bauchglueck)

# BauchGlück

 "**BauchGlück** ist eine speziell entwickelte App für Menschen nach einer **Magenbypass-Operation**. Sie vereint Ernährung, Medikation und Wohlbefinden in einer intuitiven Plattform und unterstützt Nutzer dabei, ihren Alltag zu organisieren und ihre Gesundheit im Blick zu behalten."

Die App bietet hilfreiche Tools wie Countdown-Timer zur Erinnerung an Ess- und Trinkzeiten, dokumentiert die Wasseraufnahme und den Gewichtsverlauf, verwaltet Medikamente und erinnert an die Einnahme. Zudem ermöglicht sie die einfache Planung von Mahlzeiten. Eine integrierte Community-Funktion fördert den Austausch von Rezepten unter den Nutzern.

## UX/UI

> [Figma Case Study](https://www.figma.com/design/FMorQUMx5iu7ysW2AuTS1x/Project-MagenApp?node-id=40-29&t=7M0qex8nEc9LTMWf-1)

> [Figma UX/UI Design](https://www.figma.com/design/FMorQUMx5iu7ysW2AuTS1x/Project-MagenApp?node-id=40-29&t=7M0qex8nEc9LTMWf-1)

> [Figma Pitch Presentation](./images/presentation_bauch_glueck_compressed.pdf)

## App Design



    

    

    





    

    

    



## Features

- [x] Verwaltung und Erstellung von Countdown-Timern mit Benachrichtigungen (z.B. für Ess- und Trinkzeiten)

- [x] Dokumentation und Anzeige des Gewichtsverlaufs

- [x] Eingabe und Nachverfolgung der täglichen Wasseraufnahme

- [x] Verwaltung und Erstellung von Rezepten

- [x] Verwaltung von Medikamenten mit Verfolgung der Einnahmezeiten

- [x] Planung und Verwaltung von Mahlzeitenplänen

- [x] Erstellung und Verwaltung von Einkaufslisten

- [x] Einstellungen zur Personalisierung der App und rechtliche Hinweise

## Technischer Aufbau

#### Projektaufbau

Die Projektstruktur basiert auf dem MVVM (Model-View-ViewModel) Muster auf der Client-Seite und einem Repository-Ansatz im Backend, das in Kotlin geschrieben ist. Das Backend bedient eine API und nutzt verschiedene Services für die Datenverarbeitung und Speicherung.

- app/ enthält die Android-App (MVVM).

- server/ enthält den Server-Code, geschrieben in Kotlin, der für die API und Datenverarbeitung verantwortlich ist.

#### Datenspeicherung

Die Datenspeicherung erfolgt über eine Kombination aus:

- Room Database für die lokale Speicherung in der App.

- Firebase für Authentifizierung und Cloud-Speicherung.

- Strapi Backend speichert Daten in einer relationalen Datenbank.

#### API Calls

Es werden APIs für Rezeptmanagement und Benutzerdaten verwendet. Die wichtigsten API-Endpunkte im Backend sind:

- /api/water-intake/fetchItemsAfterTimeStamp?timeStamp={timestamp}&userId={userID}

- /api/recipes/getUpdatedRecipesEntries?timeStamp={timestamp}

- /api/weight/fetchItemsAfterTimeStamp?timeStamp={timestamp}&userId={userID}

- /api/medication/getUpdatedMedicationEntries?timeStamp={timestamp}&userId={userID}

- /api/timer/fetchItemsAfterTimeStamp?timeStamp={timestamp}&userId={userID}

- /api/mealPlan/getUpdatedMealPlanDayEntries?timeStamp={timestamp}&userId={userID}

- /api/recipes/generateRecipe?category={RecipeKind}

- /api/meal/getUpdatedMealEntries?timeStamp={timestamp}

- /api/water-intake/updateRemoteData

- /api/weight/updateRemoteData

- /api/medication/syncDeviceMedicationData

- /api/timer/updateRemoteData

- /api/send-schedule-notification

- /api/upload/

- /api/appStatistics

#### Dependencies

Es ist eine gute Praxis, die verwendeten Dependencies aufzulisten. Das gibt den Nutzern deines Projekts eine klare Vorstellung davon, was im Projekt verwendet wird.

- Room 2.3.0 – Für lokale Datenbankverwaltung.

- Ktor Client – Für Netzwerkoperationen.

- Coil - Für Ayncrone Image loading und Cashing.

- Koin - für Dependency Injection

- Firebase – Für Authentifizierung und Cloud-Speicherung.

## Backend (Strapi)

The backend for this project, built with Strapi, is available in the following repository:

Repository: https://github.com/ChromeSD22159/BauchGueckStrapiBackend

Please refer to the repository's README for instructions on how to set up and run the Strapi backend server.

Important: Make sure the `API_HOST` in your local.properties configuration in your Kotlin code matches the actual URL of your running Strapi instance.

## Configuration

To ensure the application runs correctly, you need to configure both the `API_KEY` and `API_HOST` in your `local.properties` file.

### Steps for Configuration:

1. **Obtain the API Key:**

  - Log in to your Strapi dashboard.

  - Navigate to the API Token settings and copy the required API Key.

2. **Set the API Key in `local.properties`:**

  - Open the `local.properties` file in your project directory.

  - Add or update the following entry:

    ```properties

    API_KEY=

    ```

  - Replace `` with the API Key you obtained from Strapi.

3. **Configure the API Host:**

  - In the same `local.properties` file, add or update the `API_HOST` entry to match the URL of your running Strapi instance:

    ```properties

    API_HOST=

    ```

  - Replace `` with the actual URL of your Strapi instance (e.g., `http://localhost:1337`).

4. **Save and Restart:**

  - Save the `local.properties` file.

  - Restart the application to apply the changes.

These configurations ensure that the application can correctly interact with your Strapi API.

## License

This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.