Updated readme and npm scripts (#50)

README.md

@@ -2,7 +2,7 @@
 
 # Building Information Enhancer (AMOS SS 2024)
 
-This is an official repository for the `CODE.ING` group, developing a open-source `Building Information Enhancer` software for the `BUILD.ING` partner and the `AMOS 2024` project.
+This is an official repository for the `CODE.ING` group, developing an open-source `Building Information Enhancer` software for the `BUILD.ING` partner and the `AMOS 2024` project.
 
 Project Team:
 
@@ -16,10 +16,28 @@ Project Team:
 - **Lucas Nandico** (SD)
 - **Celine Pöhl** (SD)
 
-# Setup
+# System Architecture
 
-Before deploying the project be sure you have `npm` installed and a running `Docker Engine`.
+To see and read about the architecture of our system visit our GitHub [wiki](https://github.com/Corgam/SS23_ADSP_TCF/wiki) documentation.
 
-# Project Deployment
+# Setup & Deployment
 
-To deploy the project on your local machine using Docker Engine run the `npm run deploy` command.
+This project is integrated with a full CI/CD pipeline, thus deployed automatically on the web. However, it is possible to deploy a production-ready system on a local machine using Docker or deploy each part of the system separately for further development. For further information on the `CI/CD` pipeline visit our GitHub [wiki](https://github.com/Corgam/SS23_ADSP_TCF/wiki) documentation.
+
+## Deployment using Docker
+
+To deploy the project on your local machine using Docker Engine, follow the instructions below:
+
+1. Clone this repository (https://github.com/amosproj/amos2024ss04-building-information-enhancer).
+2. Before deploying the project be sure you have installed the [Node.js](https://nodejs.org/en) ( >= 20.12.2) and a running [Docker Deamon](https://docs.docker.com/engine/install/).
+3. Run the `npm run deploy` command in the root folder of the repository.
+4. Connect to the Frontend located at port 80, usually `localhost:80`.
+
+## Developement Deployment
+
+To deploy one or more services of the system separately, follow the instructions below:
+
+1. Clone this repository (https://github.com/amosproj/amos2024ss04-building-information-enhancer).
+2. Before deploying the project be sure you have installed the [Node.js](https://nodejs.org/en) ( >= 20.12.2) and a running [Docker Deamon](https://docs.docker.com/engine/install/).
+3. Run the `npm run setup` command to install all necessary packages.
+4. To deploy the frontend use the `npm run deploy:dev:frontend` command, or to deploy the backend use the `npm run deploy:dev:backend` command.

package.json

@@ -5,9 +5,10 @@
   "author": "See repository README",
   "scripts": {
     "setup": "npm run setup:frontend && npm run setup:backend",
-    "setup:frontend": "cd frontend/",
-    "setup:backend": "cd backend/public-api",
+    "setup:frontend": "cd frontend/ && npm ci",
+    "setup:backend": "cd backend/",
     "deploy": "docker compose up --build -d",
-    "push": "docker compose push"
+    "deploy:dev:frontend": "cd frontend/ && npm run dev",
+    "deploy:dev:backend": "cd backend/"
   }
 }