Merge pull request #15 from smartSenseSolutions/main

Doc sync

.github/workflows/build_backend.yaml

@@ -0,0 +1,61 @@
+---
+
+name: Build docker image- backend application
+
+on:
+  push:
+    branches:
+      - main
+    # trigger events for SemVer like tags
+    tags:
+      # match e.g. 1.1.1 and 1.1.1-rc1
+      - '[0-9]+.[0-9]+.[0-9]+'
+      - '[0-9]+.[0-9]+.[0-9]+-*'
+  pull_request:
+    branches:
+      - main
+
+
+jobs:
+  build-docker-images-backend:
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+
+      # Needed to create multi-platfrom image
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@988b5a0280414f521da01fcc63a27aeeb4b104db # v3.6.1
+
+      # Needed to create multi-platfrom image
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@49b3bc8e6bdd4a60e6116a5414239cba5943d3cf # v3.2.0
+
+      # Create SemVer or ref tags dependent of trigger event
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@8e5442c4ef9f78752691e2d8f8d19755c6f78e81 # v5.5.1
+        with:
+          images: |
+            ${{ env.IMAGE_NAMESPACE }}/${{ env.IMAGE_NAME }}
+          tags: |
+            # set latest tag for main branch
+            type=raw,value=latest,enable=${{ github.ref == format('refs/heads/{0}', 'main') }},event=pr
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}
+            type=semver,pattern={{major}}.{{minor}}
+
+      - name: Build and push
+        uses: docker/build-push-action@5cd11c3a4ced054e52742c5fd54dca954e0edd85 # v6.7.0
+        with:
+          context: .
+          file: ./edc-chat-app-backend/Dockerfile
+          platforms: linux/amd64, linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/build_frontend.yaml

@@ -0,0 +1,61 @@
+---
+
+name: Build docker image- frontend application
+
+on:
+  push:
+    branches:
+      - main
+    # trigger events for SemVer like tags
+    tags:
+      # match e.g. 1.1.1 and 1.1.1-rc1
+      - '[0-9]+.[0-9]+.[0-9]+'
+      - '[0-9]+.[0-9]+.[0-9]+-*'
+  pull_request:
+    branches:
+      - main
+
+
+jobs:
+  build-docker-images-backend:
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+
+      # Needed to create multi-platfrom image
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@988b5a0280414f521da01fcc63a27aeeb4b104db # v3.6.1
+
+      # Needed to create multi-platfrom image
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@49b3bc8e6bdd4a60e6116a5414239cba5943d3cf # v3.2.0
+
+      # Create SemVer or ref tags dependent of trigger event
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@8e5442c4ef9f78752691e2d8f8d19755c6f78e81 # v5.5.1
+        with:
+          images: |
+            ${{ env.IMAGE_NAMESPACE }}/${{ env.IMAGE_NAME }}
+          tags: |
+            # set latest tag for main branch
+            type=raw,value=latest,enable=${{ github.ref == format('refs/heads/{0}', 'main') }},event=pr
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}
+            type=semver,pattern={{major}}.{{minor}}
+
+      - name: Build and push
+        uses: docker/build-push-action@5cd11c3a4ced054e52742c5fd54dca954e0edd85 # v6.7.0
+        with:
+          context: .
+          file: ./edc-chat-app-ui/Dockerfile
+          platforms: linux/amd64, linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/trufflehog.yaml

@@ -0,0 +1,41 @@
+name: "TruffleHog"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: "0 0 * * *" # Once a day
+  workflow_dispatch:
+
+permissions:
+  actions: read
+  contents: read
+  security-events: write
+  id-token: write
+  issues: write
+
+jobs:
+  ScanSecrets:
+    name: Scan secrets
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Ensure full clone for pull request workflows
+
+      - name: TruffleHog OSS
+        id: trufflehog
+        uses: trufflesecurity/trufflehog@8a8ef8526527dd5f5d731d8e74843c121777b82d #v3.80.2
+        continue-on-error: true
+        with:
+          path: ./  # Scan the entire repository
+          base: "${{ github.event.repository.default_branch }}"  # Set base branch for comparison (pull requests)
+          extra_args: --filter-entropy=4 --results=verified,unknown --debug
+
+      - name: Scan Results Status
+        if: steps.trufflehog.outcome == 'failure'
+        run: exit 1  # Set workflow run to failure if TruffleHog finds secrets

AUTHORS.md

@@ -2,10 +2,10 @@
 
 The following people have contributed to this repository:
 
-* [Bahutik Sakhiya](https://github.com/bhautik-sakhiya), smartSense Consulting Solutions Pvt Ltd.
+* [Bhautik Sakhiya](https://github.com/bhautik-sakhiya), smartSense Consulting Solutions Pvt Ltd.
 * [Dilip Dhankecha](https://github.com/dilipdhankecha2530), smartSense Consulting Solutions Pvt Ltd.
 * [Jigar Gadhiya](https://github.com/smartjigar), smartSense Consulting Solutions Pvt Ltd.
-* [Neha Purswani](https://github.com/neha-puraswani), smartSense Consulting Solutions Pvt Ltd.
-* [Mittal Vaghela](https://github.com/mittalVaghela), smartSense Consulting Solutions Pvt Ltd.
 * [Khushboo Shah](https://github.com/khushbooshah7), smartSense Consulting Solutions Pvt Ltd.
+* [Mittal Vaghela](https://github.com/mittalVaghela), smartSense Consulting Solutions Pvt Ltd.
 * [Nitin Vavdiya](https://github.com/nitin-vavdiya), smartSense Consulting Solutions Pvt Ltd.
+* [Neha Puraswani](https://github.com/neha-puraswani), smartSense Consulting Solutions Pvt Ltd.

deployment/README.md

@@ -33,6 +33,13 @@ includes multiple components working together for real-time messaging and data t
     - The `create_database.sh` script creates required databases at startup.
 - **Note**:
     - To ensure functionality, manually run the provided `migration.sql` to create EDC-specific tables.
+#### For deployment in Windows OS
+
+  - The [create_database.sh](deployment/env/postgres/create_database.sh) needs to be modified. The `chmod +x /docker-entrypoint-initdb.d/create_databases.sh` needs to be removed.
+  - Additionally, Windows uses CRLF line separators instead of LF, causing issues while running the init script.
+    - To change the line separators in IntelliJ IDEA, go to `File -> File Properties -> Line Separators` and select `LF - Unix and macOS (\n)`.
+    - To change the line separators in Notepad++, go to `Edit -> EOL Conversion` and select `Unix (LF)`
+
 
 ### **EDC (Eclipse Data Connector)**
 
@@ -82,7 +89,7 @@ includes multiple components working together for real-time messaging and data t
 3. Start the chat with the selected business partner.
    ![start-chat.png](../docs/images/ui/start-chat.png)
 4. When message has been passed then the logs are looks like below:
-   ![logs.png](../docs/images/ui/logs.png)
+   ![logs.png](../docs/images/deployment/logs.png)
 
 ---