Skip to content
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.

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

Add onboarding guide #1

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .idea/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Empty file.
3 changes: 3 additions & 0 deletions .idea/sonarlint/issuestore/index.pb

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions .idea/sonarlint/securityhotspotstore/index.pb

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

100 changes: 99 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,99 @@
# onboarding
# Onboarding

## How to request your Demo LEAR Credential
To begin the process of obtaining your Demo LEAR Credential, please create a ticket on [ticketing system](https://ticketing.dome-marketplace-dev.org/) with the required information listed below. This will help us create your credential efficiently. Note that the Mandator data can be extracted from your organization's EIDAS digital certificate.

### Mandator Attributes:
+ Tax Identification Number:
+ Surname and Name of the employee acting as legal representative of the company
+ EmailAddress: (e.g., [email protected])
+ National Identification Number of the employee
+ Official Organisation name: (e.g., IN2, Ingeniería de la Información, S.L.)
+ Two letters representing the contry: (e.g., ES)

### Mandatee Attributes:
+ First Name: (e.g., Rubén)
+ Last Name: (e.g., Modamio)
+ Gender: (e.g., M)
+ Email: (e.g., [email protected])
+ Mobile Phone: (e.g., +34999999999)

## How to access the portal once you have your credentials

This section will guide you through the steps to access the Dome Marketplace using the VC Login option, utilizing a demo user account for demonstration purposes.

### Step 1: Access DOME Marketplace

Visit the Dome Marketplace by clicking on the following link: [DOME Marketplace](https://dome-marketplace-dev.org).

![DOME Marketplace Access](./assets/DOME_Marketplace_Access.png)

### Step 2: Sign In

1. Click on the **Sign In** button.
2. Select **VC Login** from the options available.

![Sign In and Select VC Login](./assets/Sign_In_And_Select_VC_Login.png)

A QR code will be displayed on the screen. This QR code is unique to your login session and should be scanned using the DOME Wallet app.

> **Note**: Do not attempt to scan the example QR code below, as it is only for demonstration purposes. Each QR code is unique and must be scanned during the current session to ensure security.

![QR Code Display](./assets/QR_Popup.png)

### Step 3: Log into DOME Wallet

1. Go to the DOME Wallet website: [DOME Wallet](https://dome-wallet.eu).
2. Log in using the demo user credentials:
- Username: `userWallet`
- Password: `userPass`

![Wallet Login](./assets/Wallet_Login.png)

Upon logging in, navigate to the **Credentials** tab to view the VC that will be used for this demo.

![Credentials Tab with VC](./assets/DOME_Wallet_Credentials_Page.png)

### Step 4: Scan QR Code

Go back to the **Home** screen and press the **Scan QR** button to scan the QR code displayed on the Dome Marketplace login page.

![Scan QR Button](./assets/DOME_Wallet_Home_Page.png)

### Step 5: Complete Attestation Exchange

After scanning the QR code, the Wallet and Verifier initiate the AttestationExchange process and in the wallet, you will be asked to select the credential you wish to present to enter the portal. In this example case, as we only have one, we will use that. Once selected, a pop-up will appear to confirm if we want to use that credential.

![Verifiable Credential Selection](./assets/DOME_Wallet_Select_Credential.png)

Upon successful completion, you will be redirected and logged into the marketplace.

![Attestation Exchange Success](./assets/VC_Login_Success.png)

The AttestationExchange process has concluded successfully, and you are now logged into the Dome Marketplace. You have full access to explore its functionalities and features available for demo users.

### Troubleshooting: Camera Not Activating for QR Scan

If the camera does not activate after pressing the **Scan QR** button, follow these steps:

#### Navigate to Settings

Within the DOME Wallet app, go to the **Settings** section.

#### Access Camera Settings

Find and select the **Camera** option to configure your camera settings.

![Navigate to Settings](./assets/DOME_Wallet_Settings_Page.png)

#### Select Your Camera

Choose your preferred camera for QR scanning. If you have more than one camera, you may need to select which one to use.

![Camera Settings](./assets/Dome_Wallet_Camera_Selector.png)

#### Retry QR Scan

Return to the home screen and attempt to scan the QR code again.

By following these steps, you should be able to resolve the issue with the camera not activating for QR code scanning.
Binary file added assets/DOME_Marketplace_Access.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/DOME_Wallet_Credentials_Page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/DOME_Wallet_Home_Page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/DOME_Wallet_Select_Credential.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/DOME_Wallet_Settings_Page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/Dome_Wallet_Camera_Selector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/QR_Popup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/Sign_In_And_Select_VC_Login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/VC_Login_Success.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/Wallet_Login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.