From 29002821503343d5f927a620d16e9ab8a7f9e697 Mon Sep 17 00:00:00 2001 From: Nora Blomaard Date: Wed, 9 Apr 2025 13:33:53 +0200 Subject: [PATCH 1/2] update DEVELOPMENT.md Signed-off-by: Nora Blomaard --- packages/compas-open-scd/DEVELOPMENT.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/compas-open-scd/DEVELOPMENT.md b/packages/compas-open-scd/DEVELOPMENT.md index 65a772c92f..1931d8617a 100644 --- a/packages/compas-open-scd/DEVELOPMENT.md +++ b/packages/compas-open-scd/DEVELOPMENT.md @@ -15,9 +15,11 @@ development setup. Once Node.js is installed on your system, you may get started by entering the following lines in your command prompt: ``` -git clone https://github.com/com-pas/compas-open-scd +git clone --recurse-submodules https://github.com/com-pas/compas-open-scd cd compas-open-scd npm install +npm run build +cd packages/compas-open-scd npm start ``` From fd723d39e1a9a4cdbc855e2cc241e9a9f9597107 Mon Sep 17 00:00:00 2001 From: Nora Blomaard Date: Thu, 10 Apr 2025 13:55:24 +0200 Subject: [PATCH 2/2] improve Postman instructions in DEVELOPMENT.md Signed-off-by: Nora Blomaard --- packages/compas-open-scd/DEVELOPMENT.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/packages/compas-open-scd/DEVELOPMENT.md b/packages/compas-open-scd/DEVELOPMENT.md index 1931d8617a..e7be7d7e2b 100644 --- a/packages/compas-open-scd/DEVELOPMENT.md +++ b/packages/compas-open-scd/DEVELOPMENT.md @@ -92,7 +92,7 @@ A Docker Image `compas_keycloak` is created that can be started using the follow ```shell docker run --rm --name compas_keycloak \ - -p 8089:8080 + -p 8089:8080 \ -d compas_keycloak:latest ``` @@ -101,11 +101,12 @@ There are now 3 users available to be used, `scl-data-editor`, `scl-data-reader` ### Postman -To make a call to the CoMPAS Backend Service work in CoMPAS OpenSCD we need to import an environment and authorisation -collection. These files can be found in [CoMPAS Deployment Repository](https://github.com/com-pas/compas-deployment) -in the directory `postman` (`auth.collection.json` and `local.environment.json`). +To make a call to the CoMPAS Backend Service work in CoMPAS OpenSCD we need to import an environment and authorisation collection. These files can be found in [CoMPAS Deployment Repository](https://github.com/com-pas/compas-deployment) in the directory `postman` (`auth.collection.json` and `local.environment.json`). +1. Open Postman, click the Collections tab and and import `auth.collection.json`. +2. Click the Environments tab and import `local.environment.json`. +3. In the imported collection, Select the imported environment (local). -In the authorisation collection there are called for the 3 users known within the Demo KeyCloak instance. +In the authorisation collection there are calls for the 3 users known within the Demo KeyCloak instance. If one of these calls are executed you can switch to the tab `Visualize`. There is a button to copy the bearer to the clipboard. This will also be done automatically when switching to the tab (label becomes `Copied!`). The value of the clipboard can be copied in ModHeader Extension as Authorization Header.