Changes

Page history
Update Go4Champion Dokumentation authored by diak6730's avatar diak6730
Hide whitespace changes
Inline Side-by-side
home.md
View page @ 5734740d
...@@ -14,6 +14,7 @@ title: Go4Champion - Dokumentation ...@@ -14,6 +14,7 @@ title: Go4Champion - Dokumentation
## Inhaltsverzeichnis ## Inhaltsverzeichnis
1. [Projektbeschreibung](#1-projektbeschreibung) 1. [Projektbeschreibung](#1-projektbeschreibung)
...@@ -71,14 +72,14 @@ Unser Anspruch war es, eine App zu zu entwickeln, die personalisiert arbeitet, Z ...@@ -71,14 +72,14 @@ Unser Anspruch war es, eine App zu zu entwickeln, die personalisiert arbeitet, Z
### 2.1 Teammitglieder ### 2.1 Teammitglieder
Unser Team besteht aus sechs Studierenden, die unterschiedliche Stärken in das Projekt eingebracht haben: Unser Team:
- **Selma Sagun (951418)** - s92379@bht-berlin.de - **Selma Sagun (951418)** - s92379@bht-berlin.de
- **Dilnur Akgün (100713)** - diak6730@bht-berlin.de - **Dilnur Akgün (100713)** - diak6730@bht-berlin.de
- **Mitra Dinar (944580)** - s93118@bht-berlin.de - **Mitra Dinar (944580)** - s93118@bht-berlin.de
- **Dila Gümüssoy (945656)** - s92624@bht-berlin.de - **Dila Gümüssoy (945656)** - s92624@bht-berlin.de
- **Süheyl Aslan (100703)** - suas4491@bht-berlin.de - **Süheyl Aslan (100703)** - suas4491@bht-berlin.de
- **Adham Khalil (952596)** - S93338@bht-mail.de - **Adham Khalil (952596)** - s93338@bht-berlin.de
### 2.2 Rollen ### 2.2 Rollen
...@@ -107,8 +108,8 @@ Unser Team besteht aus sechs Studierenden, die unterschiedliche Stärken in das ...@@ -107,8 +108,8 @@ Unser Team besteht aus sechs Studierenden, die unterschiedliche Stärken in das
**Backend** **Backend**
- **Java** - **Java**
- **Spring Boot** als Framework - **Spring Boot**
- **SQL** - **MySQL**
**REST API** **REST API**
- **Swagger API** - **Swagger API**
...@@ -122,25 +123,25 @@ Unser Team besteht aus sechs Studierenden, die unterschiedliche Stärken in das ...@@ -122,25 +123,25 @@ Unser Team besteht aus sechs Studierenden, die unterschiedliche Stärken in das
Für das Backend Für das Backend
- **Visual Studio Code** - **Visual Studio Code**
Für das Frontend Für das Frontend
- **Swagger UI**
Dokumentation und testen der API-Endpunkte
### 3.3 APIs und externe Dienste ### 3.3 APIs und externe Dienste
- **Claude API (Anthropic)** - **Claude API (Anthropic)**
Zur Generierung der Trainings- und Ernährungspläne per KI Zur Generierung der Trainings- und Ernährungspläne per KI
- **Swagger UI**
Dokumentation und testen der API-Endpunkte
### 3.4 Datenbank ### 3.4 Datenbank
- **SQL** - **MySQL**
Wurde zur stetigen Speicherung eingesetzt Ursprünglich wurde H2 verwendet. Im Verlauf der Entwicklung sind wir jedoch auf MySQL umgestiegen, um eine dauerhafte und zuverlässige Datenspeicherung zu ermöglichen.
## 4. Systemarchitektur & Datenmodell ## 4. Systemarchitektur & Datenmodell
### Komponentendiagramm ### 4.1 Komponentendiagramm
Alle Komponenten kommunizieren über eine REST API. Die Architektur ist modular aufgebaut, damit einzelne Teile unabhängig weiterentwickelt werden können. Alle Komponenten kommunizieren über eine REST API. Die Architektur ist modular aufgebaut, damit einzelne Teile unabhängig weiterentwickelt werden können.
...@@ -162,11 +163,11 @@ Swagger wurde verwendet, um die API-Endpunkte zu dokumentieren und zu testen. ...@@ -162,11 +163,11 @@ Swagger wurde verwendet, um die API-Endpunkte zu dokumentieren und zu testen.
### 4.3 Frontend-Struktur ### 4.3 Frontend-Struktur
Das Frontend basiert auf **React Native mit Expo Go** und **JavaScript**. Hauptfunktionen sind: Das Frontend basiert auf **React** und **JavaScript**. Hauptfunktionen sind:
- Nutzeranmeldung und Profilerstellung - Nutzeranmeldung und Profilerstellung
- Anfragen an das Backend (z.B. Trainings- und Ernährungsplan generieren) - Anfragen an das Backend (z.B. Trainings- und Ernährungsplan generieren)
- Darstellung von Trainings, Rezepten und Punkten - Darstellung von Trainings, Rezepten und Punkten
- Gamification-Elemente (Ranglisten) - Gamification-Elemente
### 4.4 Datenmodell ### 4.4 Datenmodell
...@@ -250,7 +251,7 @@ Auch hier erstellt das Backend automatisch einen Prompt als Text. Der Output erf ...@@ -250,7 +251,7 @@ Auch hier erstellt das Backend automatisch einen Prompt als Text. Der Output erf
## 5. Benutzerdokumentation ## 5. Benutzerdokumentation
### 5.2 Zielgruppen ### 5.1 Zielgruppen
Wer nutzt die App und was können die User in der App machen? Wer nutzt die App und was können die User in der App machen?
...@@ -260,9 +261,9 @@ Die App richtet sich an Personen, die ihre Fitness verbessern möchten. Es gibt ...@@ -260,9 +261,9 @@ Die App richtet sich an Personen, die ihre Fitness verbessern möchten. Es gibt
### 5.2 Navigation und Hauptfunktionen der App ### 5.2 Navigation und Hauptfunktionen der App
Die App ist in folgende Hauptbereiche unterteilt: Die App ist in folgende Hauptbereiche unterteilt:
- **Startseite**: Übersicht und Einstieg - **Home**: Übersicht und Einstieg
- **Trainingsplan**: Generierte Workouts durch KI - **My Workouts**: Generierte Workouts durch KI
- **Ernährungsplan**: Generierte Rezepte durch KI - **Nutrition**: Generierte Rezepte durch KI
- **Challenges**: Rangliste und Punkte - **Challenges**: Rangliste und Punkte
- **Profil**: Einstellungen - **Profil**: Einstellungen
...@@ -414,7 +415,7 @@ npm run dev ...@@ -414,7 +415,7 @@ npm run dev
``` ```
This will launch the app at: This will launch the app at:
👉 [http://localhost:5173](http://localhost:5173) 👉 [http://localhost:5173/](http://localhost:5173/)
--- ---
... ...
......