diff --git a/goofy-client/README.md b/goofy-client/README.md index 39ee03606f61fbb52358e0d30f29fcbcbd81498c..ec41cbe04ce6dfc57a9fbf3bbcb8c5e678c2594b 100644 --- a/goofy-client/README.md +++ b/goofy-client/README.md @@ -3,7 +3,9 @@ ## Client starten Um den Client zum laufen zu bekommen, muss zunächst ein `npm install` ausgeführt werden. --> nach dem Ausführen sollte sich ein `node_modules` Ordner im Verzeichnis befinden. <br> + +-> nach dem Ausführen sollte sich ein `node_modules` Ordner im Verzeichnis befinden. + Im Anschluß wird der Client über `npm start` gestartet. --- @@ -83,15 +85,15 @@ Mit `nx` bzw. `nx --list` krieg man eine Liste alle verfügbaren, schon von nx * </br> -## Anbei ein Ausschnitt der verfügbaren Befehle/Scripte und einer kurzen Erläuterung. +## Anbei ein Ausschnitt der verfügbaren Befehle/Scripte und einer kurzen Erläuterung | Command | Description | Examples | | :------ | :------ | :----- | | `start` | Startet den Client mit dem Port **4300** und der **proxy.conf.json** | `npm start / npm run start` | `build` | Baut das Projekt(und cached den build) | `npm run build` -| `test` | Führt alle Test's aus(***app*** + ***libraries***) | `npm run test / npm test` +| `test` | Führt alle Test's aus(**app** + **ibraries**) | `npm run test / npm test` | `test:cov` | Führt alle Test's aus und zeigt am Ende eine Übersicht der Testabdeckung | `npm run test:cov` -| `lint` | Führt das ***eslint*** für die, von den lokalen Änderungen **direkt** betroffenen, libraries aus | `npm run lint` +| `lint` | Führt das **eslint** für die, von den lokalen Änderungen **direkt** betroffenen, libraries aus | `npm run lint` | `dep-graph` | Öffnet ein Fenster zur graphischen Veranschaulichung des Zusammenspielst von app, e2e und der einzelnen libraries | `npm run dep-graph` | `cypress:open` | Öffnet ein Fenster mit cpress-runner für die Integrationtest's welche auch gleich da ausgeführt werden können | `npm run cypress:open` | `test:lib` | Führt alle Test's einer library aus(mit watch mode) | `npm run test:lib vorgang` @@ -117,4 +119,28 @@ Man bekommt am Ende eine Zusammenfassung von den Warnings und Errors. Selektiert die von den lokalen Änderung betroffenen Libraries vor und stellt diese in Rot dar. </br> (sonst identisch zu `dep-graph`) -`affected:apps`, `affected:e2e`, `affected:build` beziehen sich jeweils auf ganze Projekte/Apps. \ No newline at end of file +`affected:apps`, `affected:e2e`, `affected:build` beziehen sich jeweils auf ganze Projekte/Apps. + +## **Ngrx** + +Command zum Generieren einer state. +Beispiel für den fachlichen Vorgang: + +```code +nx g @nrwl/angular:ngrx vorgang --module=libs/vorgang-shared/src/lib/vorgang.module.ts +``` + +Es wird eine Menge Testcode generiert, es ist dem entsprechend abzuwägen, ob man sich die generieren lässt oder die Struktur selber anlegt und sich das rausschmeißen des generierten Codes spart. + +Die generierten Daten kommen in ein `+state` Verzeichnis. +die Schnittstelle zu den Componenten der `service`. + +## **Marbles** + +Für Mehr Info: <https://github.com/ReactiveX/rxjs/blob/master/docs_app/content/guide/testing/marble-testing.md#marble-syntax> + +| Marble Syntax | Description | +| :------ | :------ | +| `'-'` | frame: 1 "frame" of virtual time passing (see above description of frames). +| `'\|'` | complete: The successful completion of an observable. This is the observable producer signaling `complete()`. +| `'#'` | error: An error terminating the observable. This is the observable producer signaling `error()`.