Merge pull request #17 from smartSenseSolutions/main

Doc sync

README.md

@@ -15,7 +15,7 @@ The following table lists Business Partner Numbers (BPNs) associated with differ
 | Catena-X        | BPNL00000CATENAX | Represents the BPN assigned to the Catena-X. We can also consider as receier/consumer. |
 | Tractus-X       | BPNL0000TRACTUSX | Dataspace operator or trusted issuer                                                   |
 
-*Note: This is just to set the context of the application, you can transfer data vice versa(smartSense to Catena-X or Catena-X to smartSense).* 
+*Note: This is just to set the context of the application, you can transfer data vice versa(smartSense to Catena-X or Catena-X to smartSense) and You can also register a third participant (EDC).* 
 
 ## Tools and technology
 - Java - Spring boot
@@ -43,7 +43,7 @@ There will be some operator company(trusted issuer) which will host following co
 1. SSI Dim wallet stub application
 
 #### Note: 
-- We need to expose wallet stun on `https` URL as while verification of VP token EDC will resolve DID document on `https`. You can use `ngrok` or `tunnelmol` for this purpose.
+- We need to expose wallet stub on `https` URL as while verification of VP token, EDC will resolve DID document on `https`. You can use `ngrok` or `tunnelmol` for this purpose.
 - Alternatively, You can use hosted wallet stub application on https://wallet.learn.smartsenselabs.com for testing purpose.
 
 ### High level diagram 
@@ -69,7 +69,8 @@ Please refer [technical.md](docs/technical.md)
 
 ## Demo
 
-WIP
+<a href="https://drive.google.com/file/d/1siHmY9dEJ-3U7j8p2KTnltMvW37X01Bv/view?usp=drive_link" target="_blank">Chat application using EDC demo</a>
+
 
 ## Out of scope
 - Any authentication and authorization 

deployment/README.md

@@ -72,9 +72,11 @@ includes multiple components working together for real-time messaging and data t
 
 ### **Steps to Deploy**
 
+*Note: below steps are tested with `Docker version 27.3.1`*
+
 1. Run the following command to start the deployment:
    ```bash
-   docker-compose up --build
+   docker compose up --build
 
 2. After the deployment the stack will look like below:
    ![img.png](../docs/images/deployment/deployment-stack.png)
@@ -102,7 +104,7 @@ includes multiple components working together for real-time messaging and data t
     4. catena-x-ui
 2. After commenting this, use the below commands which will deploy the Edc and it's relevant services.
    ```bash
-   docker-compose up -d
+   docker compose up -d
 
 ---
 
@@ -112,10 +114,10 @@ includes multiple components working together for real-time messaging and data t
 1. remove the `postgres_data` folder from the root path of the code.
 2. Once removal is done, execute the below command.
     ```bash
-   docker-compose down -v
+   docker compose down -v
 3. After removing the data and all, we will run the whole stack again with below command.
     ```bash
-   docker-compose up -d
+   docker compose up -d
 
 ---
 
@@ -124,6 +126,9 @@ includes multiple components working together for real-time messaging and data t
 The **wallet-stub** service is currently deployed in our shared environment
 at:[wallet-stub](https://wallet.learn.smartsenselabs.com/ui/swagger-ui/index.html).
 
+- Make sure your wallet is created in [Wallet stub application](https://wallet.learn.smartsenselabs.com/ui/swagger-ui/index.html) if you are changing or register new BPNs before starting data transfer/chat.
+- You can create wallets just by calling ``https://wallet.learn.smartsenselabs.com/yourBPN/did.json`` URL in the browser.
+
 If you want to deploy the wallet-stub service in your local environment, follow these steps:
 
 1. Open the `docker-compose.yaml` file in your project directory.
@@ -132,4 +137,4 @@ If you want to deploy the wallet-stub service in your local environment, follow
 4. Expose port `80` with ngrok and update the above host with the ngrok url.
 5. Run the Docker Compose command to start the services:
    ```bash
-   docker-compose up -d
+   docker compose up -d

docker-compose.yaml

@@ -253,6 +253,9 @@ services:
       retries: 3
       start_period: 30s
 
+# Service to register a business partner in the backend application to avoid manual data creation.
+# This will register smartSense's EDC into the Catena-X backend and vice versa.
+# This could be automated using a central service, i.e., the EDC Discovery Service.
   bp-registration:
     image: alpine/curl
     container_name: bp-registration
@@ -295,6 +298,9 @@ services:
     networks:
       - edc-network
 
+# This script creates missing tables in the EDC database. 
+# Ideally, migrations should handle this, but due to an issue in EDC 0.7.7, some tables were not created. 
+# To save time, we added this script as a precaution; it will only create tables if they don't exist.
   smartsense-edc-migration:
     image: flyway/flyway:latest
     container_name: smartsense-edc-migration