From bfe67a8b95a4d2946d3fc713ed7ede05ea25240d Mon Sep 17 00:00:00 2001
From: lcross2002 <liamdcross@outlook.com>
Date: Mon, 8 Apr 2024 13:56:21 +0100
Subject: [PATCH] update readme for dev instructions
---
client/README.md | 34 +++++++++++++++++-----------------
1 file changed, 17 insertions(+), 17 deletions(-)
diff --git a/client/README.md b/client/README.md
index d28ff72..c391b52 100644
--- a/client/README.md
+++ b/client/README.md
@@ -1,22 +1,22 @@
# Airline Booking System client
-## How to develop the UI without docker
+## How to develop the Client
-Make sure you have node installed (e.g. version v20.11.0 which was used to create this).
+Make sure you have docker (latest) and node installed (e.g. node version v20.11.0 which was used to create this).
1. Install vite globally via `npm install -g vite`
-2. Navigate to the client directory
-3. Run `npm install`
-4. Run `npm run dev`
-5. Make changes
-6. Go to http://localhost:8080/ to see the changes
-
-## How to run the UI alone via docker
-
-Note: this does not run the microservices.
-Make sure you have docker installed.
-
-1. Navigate to the client directory
-2. Run `docker build . -t "airline-client"`
-3. Run `docker run -p 8080:8080 airline-client`
-4. Go to http://localhost:8080/ to view
\ No newline at end of file
+2. Comment out the client from the docker-compose file:
+```yml
+ # client:
+ # build:
+ # context: ./client
+ # image: client:${IMAGE_TAG}
+ # ports:
+ # - "${CLIENT_PORT}:4200"
+```
+3. Run `docker compose up -d --build`
+4. Navigate to the client directory
+5. Run `npm install`
+6. Run `npm run dev`
+7. Go to http://localhost:4200/ to view the app
+8. Make changes save the files and refresh the page
\ No newline at end of file
--
GitLab