Skip to content
Snippets Groups Projects
Unverified Commit b0c23e89 authored by Florian Raith's avatar Florian Raith Committed by GitHub
Browse files

Add images to README.md

parent 6118ffa3
No related branches found
No related tags found
No related merge requests found
......@@ -17,6 +17,10 @@
Falls noch nicht passiert `Docker` starten
So sieht die Docker App unter Windows frisch installiert dann aus
![QlV491s](https://github.com/KIT-PSE/collab-space-app/assets/37345813/bc18c12f-fa87-486d-b7bf-4e79e91da97f)
### 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.
![lmaXxHz](https://github.com/KIT-PSE/collab-space-app/assets/37345813/e7148a82-3518-4fe4-93d1-20e2e41a88de)
### 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.
![1wFjL41](https://github.com/KIT-PSE/collab-space-app/assets/37345813/e49a3288-9fff-4434-81e7-17a4f68d5616)
### 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
```
![F2V6o9A](https://github.com/KIT-PSE/collab-space-app/assets/37345813/bb1b8013-8046-421c-b2e9-1a146e80b6ab)
Wenn alles geklappt hat sollte man jetzt im Browser jetzt die Seite `localhost:5173` öffnen können und sieht die App.
![DQ5Nbbq](https://github.com/KIT-PSE/collab-space-app/assets/37345813/b8e1d8ba-a687-4518-838e-1a0b9a2d8335)
## 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.
![frfinHJ](https://github.com/KIT-PSE/collab-space-app/assets/37345813/4c3f7a0e-0aab-48c9-8118-871bbff8a697)
## 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.
![Nr7RYXE](https://github.com/KIT-PSE/collab-space-app/assets/37345813/10460c8f-f8ce-42d4-b2cb-011c281e1a69)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment