Skip to content

update DEVELOPMENT.md #370

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

update DEVELOPMENT.md #370

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2900282
update DEVELOPMENT.md
noraeb Apr 9, 2025
fd723d3
improve Postman instructions in DEVELOPMENT.md
noraeb Apr 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions packages/compas-open-scd/DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down Expand Up @@ -90,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
```

Expand All @@ -99,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.
Expand Down