Studien Generator App

Projektbeschreibung

Dieses Projekt zielt darauf ab, eine generische Anwendung für wissenschaftliche Studien zu entwickeln. Diese App wird in Zusammenarbeit mit dem Zentralinstitut für Seelische Gesundheit (ZI) in Mannheim erstellt und soll dazu dienen, das Management von Studien sowie die Erfassung und Verwaltung von Teilnehmerdaten zu ermöglichen.

Technologie Stack

Die App wird mit folgenden Technologien entwickelt:

• Frontend: React (PWA)
• Backend: Nest.js
• Datenbank: MySQL

Anwendungsfunktionen

Die App besteht aus zwei Teilen:

1. Admin-App: Dient der Administration und Verwaltung der Studien. Hier können neue Studien erstellt, bestehende Studien bearbeitet und Teilnehmer verwaltet werden.

2. Studien-App: Hier können die Teilnehmer ihre Daten erfassen. Die Teilnehmer können sich für Studien anmelden, ihre persönlichen Daten eingeben und ihre Studiendaten einreichen.

Getting started

Builden der Anwendung

docker-compose -f "prod-docker-compose.yaml" build --no-cache

Starten der Anwendung

docker-compose -f "prod-docker-compose.yaml" up -d

Ausführen der Datenbank Migrations

docker-compose -f "prod-docker-compose.yaml" exec admin-backend npm run db:migration:run

Development

Starten der Datenbank

Starten des lokalen Datenbankservers

docker-compose -f "dev-docker-compose.yaml" up -d

Starten des Admin-Backends

Navigiere in den Order backend

cd backend

Installiere alle npm Pakete

npm install

Starte den lokalen Backendserver

npm run start:admin:dev

Die App benötigt folgende Umgebungsvariablen:

Variable	Bedeutung
ACTIVATION_PASSWORD	Administrator Passwort
JWT_SECRET	JWT Secret für das signieren von Tokens
ORIGIN	URI des Admin Frontends
STUDY_FRONTED_URI	URI des Study Frontends
PORT	Port der Admin App

Starten des Study-Backends

Navigiere in den Order backend

cd backend

Installiere alle npm Pakete

npm install

Starte den lokalen Backendserver

npm run start:study:dev

Die App benötigt folgende Umgebungsvariablen:

Variable	Bedeutung
ORIGIN	URI des Study-Frontends
JWT_SECRET	Secrect zum Erstellen der JWT
VAPID_PUBLIC_KEY	gültiger public VAPID KEY https://vapidkeys.com
VAPID_PRIVATE_KEY	gültiger und passender private VAPID KEY https://vapidkeys.com

Datenbank an Backend anbinden

Um das Admin und Study Backend mit der Datenbank zu verbinden, benötigt beide Apps folgende Umgebungsvariablen:

Variable	Bedeutung
DB_HOST	Host der Datenbank
DB_PORT	Port des Datenbankservers
DB_USER	Datenbank Benutzer
DB_PASSWORD	Datenbank Passwort
DB_NAME	Name der Datenbank

Starten der Admin App (Frontend)

Navigiere in den Order frontend/admin-app

cd frontend/admin-app

Die App benötigt folgende Umgebungsvariablen:

Variable	Bedeutung
VITE_API_URI	URI des Admin-Backends

Installiere alle npm Pakete

npm install

Starte die Anwendung

npm start

Starten der Studien App (Frontend)

Navigiere in den Order frontend/study-app

cd frontend/study-app

Die App benötigt folgende Umgebungsvariablen:

Variable	Bedeutung
VITE_API_URI	URI des Study-Backends
VITE_VAPID_PUBLIC_KEY	gültigen public VAPID KEY https://vapidkeys.com

Installiere alle npm Pakete

npm install

Starte die Anwendung

npm start

Code Generierung

Im Frontend wird der Code Generator "plop.js" eingesetzt.

Plop Dokumentation

Testen

Integration Tests

Navigiere in den Ordner backend

cd backend

Teste die Endpoints des Admin-Backends

npm run test:admin

Teste die Endpoints des Study-Backends

npm run test:study:integration

End To End Tests

Starten der Anwendung

docker-compose -f "prod-docker-compose.yaml" up -d

Cypress

Navigiere in den Ordner test/cypress

cd tests/cypress

Teste die Admin App

npm run test:admin-app

Teste die Studien App

npm run test:study-app

Puppeteer

Navigiere in den Ordner test/puppeteer

cd tests/puppeteer

Teste die Studien App

npm run test:study-app