Skip to content
Snippets Groups Projects
Commit 234cb30d authored by OZGCloud's avatar OZGCloud
Browse files

OZG-2958 OZG-3283 Refactor documentation

parent b241b859
No related branches found
No related tags found
No related merge requests found
# GoofyClient
# Alfa Frontend
## Lokale Entwicklungsumgebung
Informationen zur lokalen Installation sind unter [dokumentation/Entwicklungsumgebung/README.md](../../../../../dokumentation/src/branch/master/Entwicklungsumgebung/README.md#angular-frontend)
Besteht aus:
## Alfa Frontend starten
* Node 16 (getestet: 16.18.1)
* NPM 8 (getestet: 8.19.2)
* Docker (Linux) bzw. Docker Desktop (Linux, Mac, Windows)
* docker compose v2 [installieren](https://github.com/docker/compose) (Linux) bzw. aktivieren (Docker Desktop)
* Einem Editor wie [Visual Studio Code](https://code.visualstudio.com/)
### Node 16 / NPM 8 installieren
Linux:
* Der eigenen Distribution entsprechende Dokumentation unter https://nodejs.org/en/download/package-manager/
* Beispiel Debian:
* https://deb.nodesource.com/setup_16.x prüfen auf Schadcode
* Installieren:
```
curl -fsSL https://deb.nodesource.com/setup_16.x | bash - &&\
apt-get install -y nodejs
```
Mac:
* Homebrew installieren:
* Anleitung auf https://brew.sh folgen
* Hinweis: https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh prüfen auf Schadcode vor der Installation
* Node 16 installieren: `brew install node@16`
Windows:
* Download des Installers von https://nodejs.org/download/release/v16.18.1/
## Client starten
Um den Client zum Laufen zu bekommen, muss zunächst ein `npm install --legacy-peer-deps` ausgeführt werden.
Um das Alfa Frontend zum Laufen zu bekommen, muss zunächst ein `npm install --legacy-peer-deps` ausgeführt werden.
-> nach dem Ausführen sollte sich ein `node_modules` Ordner im Verzeichnis befinden.
Im Anschluß wird der Client über `npm start` gestartet.
Im Anschluß wird das Alfa Frontend über `npm start` gestartet.
Hinweise:
......@@ -216,7 +184,7 @@ Selektiert die von den lokalen Änderung betroffenen Libraries vor und stellt di
`affected:apps`, `affected:e2e`, `affected:build` beziehen sich jeweils auf ganze Projekte/Apps.
## **Ngrx**
## Ngrx
Command zum Generieren einer state.
Beispiel für den fachlichen Vorgang:
......@@ -230,7 +198,7 @@ Es wird eine Menge Testcode generiert, es ist dem entsprechend abzuwägen, ob ma
Die generierten Daten kommen in ein `+state` Verzeichnis.
die Schnittstelle zu den Componenten der `service`.
## **Marbles**
## Marbles
Für Mehr Info: <https://github.com/ReactiveX/rxjs/blob/master/docs_app/content/guide/testing/marble-testing.md#marble-syntax>
......@@ -294,19 +262,3 @@ Beispiel: `settings` nach `user-settings`
- /settings => /user-settings
- Settings => UserSettings
- goofy-client-settings => goofy-client-user-settings
## NodeJs
Für eine angenehme Handhabung mehrerer NodeJs Version kann [nvm](https://nodejs.org/en/download/package-manager/#nvm) oder `n` genutzt wird.
### NVM
Installiert werden kann es unter anderem mit `curl https://raw.githubusercontent.com/creationix/nvm/master/install.sh | bash`.
Anschließend `source ~/.profile` zum fetchen ausführen.
`nvm ls-remote` -> kann man sich eine Liste verfügbarer Versionen anzeigen lassen.
`nvm install v16.8.1` -> installiert die entsprechende Version.
`nvm use v16.18.1` -> setzt die Version als Default/aktuell genutzte Version.
### N
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment