diff --git a/goofy-client/README.md b/goofy-client/README.md index 531d493c2a5696aa0b53cc73536d436b036697f8..efb926e70df54c415e7e81cab2645b775e47d201 100644 --- a/goofy-client/README.md +++ b/goofy-client/README.md @@ -1,15 +1,16 @@ # GoofyClient ## Client starten -Um den Client zum laufen zu bekommen, muss zunächst ein `npm install` ausgeführt werden. <br> + +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> Im Anschluß wird der Client über `npm start` gestartet. -# +--- ## Common information to Nx from Nx -This project was generated using [Nx](https://nx.dev). +This project was generated using [Nx](https://nx.dev). [Nx Documentation](https://nx.dev/angular) @@ -40,36 +41,44 @@ Libraries are sharable across libraries and applications. They can be imported f ## Generate a Component -Run `ng g component my-component --project=my-app` to generate a new component. +Run +```bash +ng g component my-component --project=my-app +``` -# +to generate a new component. +## Allgemein -## Allgemein Man kann mit Hilfe von `nx --help` eine Liste von Befehlen mit kurzen Erläuterung bekommen. </br> -### NG/NX short explanation +## NG/NX short explanation - Angular ClI = **ng** - Nx Cli = **nx** Nx Cli baut auf Angular Cli auf ist jedoch wesentlich schneller bspw. durch + - _advanced code analysis_ - _computation caching (reuse previous results)_ Sofern die Commands für das Generieren von Code genutzt werden, so ist der generierte Code immer derselbe! -### `Install NX global` - npm install -g nx +## `Install NX global` + +```bash +npm install -g nx +``` Mit `nx` bzw. `nx --list` krieg man eine Liste alle verfügbaren, schon von nx **vordefinierten** commands an </br> ## 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` @@ -80,28 +89,26 @@ Mit `nx` bzw. `nx --list` krieg man eine Liste alle verfügbaren, schon von nx * | `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` -| `test:debug:lib` | Führt alle Test's einer library und zeigt zusätzlich eine genauere Fehlermeldung an(mit watch mode) | `npm run test:debug:lib vorgang` - - </br> - </br> +| `test:debug:lib` | Führt alle Test's einer library und zeigt zusätzlich eine genauere Fehlermeldung an(mit watch mode) | `npm run test:debug:lib vorgang` ## Affected + Hier eine kurze Liste mit den wichtigsten Befehlen: `affected:*`: </br> Bezieht sich meistens auf die von den lokalen Änderungen betroffenen Libraries, kann sich aber auch auf die betroffenen Projekte beziehen. - `affected:libs` - Zeigt eine Liste der Libraries die von den lokalen Änderungen betroffen sind </br> - (hier kann man zusätzlich auch den `dep-graph` zur Hand nehmen für eine bessere Übersicht) +Zeigt eine Liste der Libraries die von den lokalen Änderungen betroffen sind </br> +(hier kann man zusätzlich auch den `dep-graph` zur Hand nehmen für eine bessere Übersicht) - `affected:test` - Führt die Test's für die Libraries aus die von den lokalen Änderungen betroffen sind.</br> - (inklusive der app Test's) +Führt die Test's für die Libraries aus die von den lokalen Änderungen betroffen sind.</br> +(inklusive der app Test's) - `affected:lint` - Führt das eslint über die betroffenen Libraries aus. </br> - Man bekommt am Ende eine Zusammenfassung von den Warnings und Errors. +Führt das eslint über die betroffenen Libraries aus. </br> +Man bekommt am Ende eine Zusammenfassung von den Warnings und Errors. - `affected:dep-graph` - Selektiert die von den lokalen Änderung betroffenen Libraries vor und stellt diese in Rot dar. </br> - (sonst identisch zu `dep-graph`) +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