Skip to content

This repository hosts source code for the reference implementation of the GovStack Consent Building Block Privacy Dashboard (WebClient)) towards individuals.

License

Notifications You must be signed in to change notification settings

decentralised-dataexchange/bb-consent-privacy-dashboard

Repository files navigation

GovStack Consent BB Privacy Dashboard (WebClient)

AboutRelease StatusContributingLicensing

About

This repository hosts source code for the reference implementation of the GovStack Consent Building Block Privacy Dashboard (WebClient) towards individuals.

Release Status

Released. Refer to the wiki page for the latest status of the deliverables.

Instructions to run the docker image

docker run -p 3030:80 igrantio/bb-consent-privacy-dashboard:<tag>

Example: To run 2023.11.4 execute the following command in the terminal

docker run -p 3030:80 igrantio/bb-consent-privacy-dashboard:2023.11.4

In case you wish to override the base URL for consent-bb API server to connect to from the admin dashboard, use the following command:

docker run -v ./config.json:/usr/share/nginx/html/config/config.json -p 3030:80 igrantio/bb-consent-privacy-dashboard:2023.11.4

A sample config

{
  "baseUrl": "https://api.igrant.dev/v2",
  "redirectUrl": "https://staging-consent-bb-privacy-dashboard.igrant.io/login",
  "clientId": "igrant-ios-app"
}

The privacy dashboard can be run at http://localhost:3030/#/login.

Instructions to build from source and run

Follow the steps below to get the admin dashboard up and running locally.

  1. Clone this repository to your local server using git clone.
  2. Check out the latest release or any available release you wish to run.
  3. Modify the public/config/config.json file attribute baseUrl in the root folder to point to the Consent BB API server instance.
  4. Execute make setup. This establishes the necessary dependencies and configurations for running the admin dashboard instance.
  5. Execute make build. The compiles and assembles source code into executable files or libraries, following the instructions specified in the Makefile of the admin dashboard instance.
  6. Execute make run. This executes a predefined set of instructions in the Makefile to launch or run the compiled admin dashboard server instance.

The consent BB admin dashboard can now be accessed at https://privacy.bb-consent.dev If you have security issues with your browser, you must establish a self-signed certificate.

Other resources

Contributing

Feel free to improve the plugin and send us a pull request. If you find any problems, please create an issue in this repo.

Licensing

Copyright (c) 2023-25 LCubed AB (iGrant.io), Sweden

Licensed under the Apache 2.0 License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the LICENSE for the specific language governing permissions and limitations under the License.

About

This repository hosts source code for the reference implementation of the GovStack Consent Building Block Privacy Dashboard (WebClient)) towards individuals.

Resources

License

Stars

Watchers

Forks

Packages

No packages published