Skip to content

ConductionNL/digispoof-interface

Repository files navigation

Additional Information

For deployment to kubernetes clusters we use Helm 3.

For an in depth installation guide you can refer to the installation guide.

Description

Digispoof is an application that mocks the DigiD login.

Digispoof provides a list of citizens that is provided by the BRPService. When selecting one of the citizens from the dropdown menu digispoof will then do an POST request to the provided responseUrl. In the post will be the bsn of the chosen citizen.

The bsn can used to get a set of information about that citizen from the BRPService.

All the information received is fictive but does represent what you would receive from DigiD.

Digispoof supports the following query parameters:

responseUrl:

This parameter is required.

This url will be used as the POST action in the html form. The application will then have to process the bsn provided by digispoof in this url.

backUrl:

This parameter is optional.

when provided it will also send back_url back to the provided responceUrl. Which can then be used to redirect your user to the provided backUrl in your application.

An example of what the url might be like:

https://zuid-drecht.nl/digispoof?responseUrl=https://zuid-drecht.nl/auth/digispoof&backUrl=https://zuid-drecht.nl/

More information about the BRP mock can be found here.

Additional Information

Tutorial

For information on how to work with the component you can refer to the tutorial here.

Setup your local environment

Before we can spin up our component we must first get a local copy from our repository, we can either do this through the command line or use a Git client.

For this example we're going to use GitKraken but you can use any tool you like, feel free to skip this part if you are already familiar with setting up a local clone of your repository.

Open gitkraken press "clone a repo" and fill in the form (select where on your local machine you want the repository to be stored, and fill in the link of your repository on github), press "clone a repo" and you should then see GitKraken downloading your code. After it's done press "open now" (in the box on top) and voilá your codebase (you should see an initial commit on a master branch).

You can now navigate to the folder where you just installed your code, it should contain some folders and files and generally look like this. We will get into the files later, lets first spin up our component!

Next make sure you have docker desktop running on your computer.

Open a command window (example) and browse to the folder where you just stuffed your code, navigating in a command window is done by cd, so for our example we could type cd c:\repos\common-ground\my-component (if you installed your code on a different disk then where the cmd window opens first type : for example D: and hit enter to go to that disk, D in this case). We are now in our folder, so let's go! Type docker-compose up and hit enter. From now on whenever we describe a command line command we will document it as follows (the $ isn't actually typed but represents your folder structure):

$ docker-compose up

Your computer should now start up your local development environment. Don't worry about al the code coming by, let's just wait until it finishes. You're free to watch along and see what exactly docker is doing, you will know when it's finished when it tells you that it is ready to handle connections.

Open your browser type http://localhost/ as address and hit enter, you should now see your common ground component up and running.

Credits

Information about the authors of this component can be found here

This component is based on Digid

Copyright © Utrecht 2019