Update home authored by diak6730's avatar diak6730
...@@ -5,14 +5,14 @@ ...@@ -5,14 +5,14 @@
1. [Projektbeschreibung](./Projektbeschreibung) 1. [Projektbeschreibung](./Projektbeschreibung)
2. [Team](./Team) 2. [Team](./Team)
3. [Tech-Stack](./Tech-Stack) 3. [Tech-Stack](./Tech-Stack)
4. [Systemarchitektur & Datenmodell](./Systemarchitektur) 4. [Systemarchitektur & Datenmodell](./Systemarchitektur-Datenmodell)
5. [Benutzerdokumentation](./Benutzerdokumentation) 5. [Benutzerdokumentation](./Benutzerdokumentation)
6. [Entwicklerdokumentation](./Entwicklerdokumentation) 6. [Entwicklerdokumentation](./Entwicklerdokumentation)
7. [Testing & Qualitätssicherung](./Testing) 7. [Testing](./Testing)
8. [Projektdurchführung](./Projektorga) 8. [Arbeitsprozess](./Arbeitsprozess)
9. [Ergebnisse & Reflexion](./Reflexion) 9. [Reflexion](./Reflexion)
10. [Ausblick & Weiterentwicklung](./Ausblick) 10. [Ausblick & Future Work](./Ausblick-Future-Work)
11. [Quellen & Danksagung](./Quellen) 11. [Quellen](./Quellen)
12. [Anhang](./Anhang) 12. [Anhang](./Anhang)
...@@ -212,10 +212,32 @@ sequenceDiagram ...@@ -212,10 +212,32 @@ sequenceDiagram
Frontend-->>User: Zeigt neuen Ernährungsplan an Frontend-->>User: Zeigt neuen Ernährungsplan an
``` ```
# 5. Benutzerdokumentation
## 5.2 Zielgruppen
Wer nutzt die App und was können die User in der App machen?
# 📘 Developer Guide – Project Setup & Local Development Die App richtet sich an Personen, die ihre Fitness verbessern möchten. Es gibt aktuell nur eine Rolle und das ist der User. Nutzer:innen können Trainings- und Ernährungspläne generieren lassen, an Challenges teilnehmen und Punkte sammeln.
## 5.2 Navigation und Hauptfunktionen der App
Die App ist in folgende Hauptbereiche unterteilt:
- **Startseite**: Übersicht und Einstieg
- **Trainingsplan**: Generierte Workouts durch KI
- **Ernährungsplan**: Generierte Rezepte durch KI
- **Challenges**: Rangliste und Punkte
- **Profil**: Einstellungen
## 5.3 Hilfe & FAQ
Für allgemeine Fragen und Fragen zur Bedienung gibt es in der App einen eigenen FAQ-Bereich.
# 6. 📘 Developer Guide – Project Setup & Local Development
Welcome to this open-source project! Welcome to this open-source project!
This guide explains how to set up and run the application locally. It ensures that all contributors use a consistent environment to streamline development and collaboration. This guide explains how to set up and run the application locally. It ensures that all contributors use a consistent environment to streamline development and collaboration.
...@@ -235,7 +257,7 @@ To avoid compatibility issues, please use the following versions: ...@@ -235,7 +257,7 @@ To avoid compatibility issues, please use the following versions:
| npm | 10.9.2 | | npm | 10.9.2 |
| Spring Boot | 3.4.4 | | Spring Boot | 3.4.4 |
| Maven | 3.9.9 | | Maven | 3.9.9 |
| H2 Database | 2024-08-11 | | MySQL | 9.3.0 |
--- ---
...@@ -316,13 +338,12 @@ mvn spring-boot:run ...@@ -316,13 +338,12 @@ mvn spring-boot:run
When running: When running:
- Swagger UI: [http://localhost:8080/swagger-ui.html](http://localhost:8080/swagger-ui.html) - Swagger UI: [http://localhost:8080/swagger-ui.html](http://localhost:8080/swagger-ui.html)
- H2 Console: [http://localhost:8080/h2-console](http://localhost:8080/h2-console)
**H2 Login:** **MySQL Login:**
- JDBC URL: `jdbc:h2:mem:testdb` - JDBC URL: `jdbc:mysql://localhost:3306/go4champ`
- Username: `sa` - Username: `go4champ_user`
- Password: *(leave blank)* - Password: <...>
--- ---
...@@ -418,3 +439,80 @@ npm run dev ...@@ -418,3 +439,80 @@ npm run dev
Feel free to fork, branch, and open merge requests! Feel free to fork, branch, and open merge requests!
We welcome all contributions. We welcome all contributions.
# 7. Testing
## 7.1 Playtest
Testplan
Ergebnisse
Analysen
Schlussfolgerungen
Actions
## 7.2 Integrationstests
### 7.3 Testreport
## 7.4 CI/CD Pipeline idealerweise integriert
# 8. Arbeitsprozess
## 8.1 Tools für die Zusammenarbeit
- **GitLab**: Codeverwaltung, Versionskontrolle, Wiki (Dokumentation), Issues
## 8.2 Meetings
- Teammetings über Discord
- On-Demand-Calls bei Fragen (ebenfalls über Discord)
## 8.3 Vorgehen
- Aufgaben wurden entweder über GitLab Issues oder in Meetings verteilt
# 9. Reflexion
## 9.1 Was lief gut?
-
## 9.2 Besonderheiten & Herausforderungen
## 9.3 Persönliche Learnings
## 9.4 Rückblick & Verbesserungen
## 9.5 Was ich aus der Veranstaltung mitgenommen habe
# 10. Ausblick & Future Work
## 10.1 Offene Punkte
- Ernährungsplan
- KI Chatbot
## 10.2 Ideen für zukünftige Features
# 11. Quellen
- KI (ChatGPT, Gemini)
- YouTube Tutorials
- Mermaid
# 12. Anhang
## 12.1 Meeting-Protokolle
## 12.2 Skizzen & Ideen
## 12.3 Mock-ups
## 12.4 Abschlusspräsentation