diff --git a/README.md b/README.md index ddd44022f3b370de5eff864c14f4d49aed191b9d..31ecbb18c778dc376b54f316fbc696f3d94fa330 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,10 @@ Falls noch nicht passiert `Docker` starten +So sieht die Docker App unter Windows frisch installiert dann aus + + + ### Repository klonen Erstelle und navigiere mit der Konsole der Ordner, in den die Repository gespeichert werden soll (z.B. `mkdir pse && cd pse`). Unter diesem Ort führe folgenden Befehl aus: @@ -31,6 +35,8 @@ git clone --recurse-submodules git@github.com:KIT-PSE/collab-space-app.git Mit dem Befehl `ls` kann verifziert werden, ob alles geklappt hat und der Ordner `collab-space-app` nun existiert. + + ### Container starten Navigiere mit dem Befehl `cd collab-space-app` in den App Ordner und führe in diesem folgenden Befehl aus: @@ -48,6 +54,8 @@ docker compose up Der erste Start dauert etwas länger da erstmal alle Docker Images (wie zum Beispiel *Node* oder *MySQL*) heruntergeladen werden müssen. Sobald der erste Start erfolgreich war laufen die nächsten Starts ziemlich schnell. + + ### Datenbank initialisieren Nach dem ersten Start ist die Datenbank noch nicht für die App fertig eingerichtet. Dazu in einem zweiten Konsolen Fenster (weil in dem anderem die App grade läuft) erstmal wieder zu dem App Ordner (mit `cd ...`) navigieren und dann folgenden Befehl ausführen: @@ -64,12 +72,21 @@ Als nächstes kann noch in die Datenbank ein paar Testdaten hinzugefügt werden docker compose exec backend npx mikro-orm seeder:run ``` + + Wenn alles geklappt hat sollte man jetzt im Browser jetzt die Seite `localhost:5173` öffnen können und sieht die App. + + + ## App stoppen Zum Stoppen der App kann in dem Konsolen Fenster in dem die App läuft `Strg+C` gedrückt werden. Falls das Konsolen Fenster ausversehen geschlossen wurde aber die App immer noch läuft (unter `localhost:5173` ist noch etwas zu sehen) kann mit `docker compose down` im entsprechendem Ordner die App gestoppt werden. + + ## App starten -Nachdem oben die Schritte befolgt wurden ist zum Starten der App nur der Befehl `docker compose up` im entsprechnedem Ordner notwendig. \ No newline at end of file +Nachdem oben die Schritte befolgt wurden ist zum Starten der App nur der Befehl `docker compose up` im entsprechnedem Ordner notwendig. + +