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 react sample application. #17

Merged
Merged
Show file tree
Hide file tree
Changes from 38 commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
3c3e360
Add react sample application.
nipunsampath Jul 26, 2023
45325d7
Update the sample app to support the latest onfido connector
AfraHussaindeen Aug 18, 2024
565fb21
Update the README
AfraHussaindeen Aug 19, 2024
1b7bddf
Add support for Onfido verification reinitiation
AfraHussaindeen Aug 25, 2024
d49bba8
Upgrade the onfido versions to the latest
AfraHussaindeen Aug 25, 2024
c9b45a2
Add Oxygen UI, implement new theme, and update navigation bar
AfraHussaindeen Aug 28, 2024
e8f3154
Add support to set a BASE URL
brionmario Aug 29, 2024
00ad318
Remove hardcoded dev mode build
brionmario Aug 29, 2024
7467ac5
Remove prebuild install script
brionmario Aug 29, 2024
e40164c
Merge pull request #1 from brionmario/guardio-life
AfraHussaindeen Aug 30, 2024
167b9e4
Update the UI styles
AfraHussaindeen Aug 31, 2024
289d638
Update the footer style
AfraHussaindeen Aug 31, 2024
87646a9
Update styles
AfraHussaindeen Aug 31, 2024
9e5e200
Remove the redirection to a separate login page
AfraHussaindeen Sep 1, 2024
c6ee6fe
Remove unused files and create a public folder
AfraHussaindeen Sep 1, 2024
5cca787
Add runtime config loader
AfraHussaindeen Sep 1, 2024
135db56
Centralize the config management and improve the UI
AfraHussaindeen Sep 2, 2024
38c04ed
Update configs
AfraHussaindeen Sep 2, 2024
cbea177
Center Onfido SDK UI
AfraHussaindeen Sep 3, 2024
cb182a7
Remove unused file
AfraHussaindeen Sep 3, 2024
3fc83b6
fix path
AfraHussaindeen Sep 3, 2024
fb220c1
Fix navigation path
AfraHussaindeen Sep 4, 2024
87c625b
UI improvements to age verification based subscription flow
pavinduLakshan Sep 13, 2024
7971638
Discard changes to samples/react-sample-app/public/runtime-config.json
pavinduLakshan Sep 13, 2024
5c14d98
Merge pull request #3 from pavinduLakshan/onfido_ui_improvements
AfraHussaindeen Sep 13, 2024
2890ae1
Show one time age verification successful message in subscriptions page
pavinduLakshan Sep 13, 2024
8298ef5
Merge branch 'guardio-life' of https://github.com/AfraHussaindeen/ide…
pavinduLakshan Sep 13, 2024
6fce003
Update success message
pavinduLakshan Sep 13, 2024
65c4d7f
Update success banner background color
pavinduLakshan Sep 13, 2024
5cf4cea
Merge pull request #4 from pavinduLakshan/onfido_ui_improvements
AfraHussaindeen Sep 13, 2024
c0e3aad
change the root path
AfraHussaindeen Sep 20, 2024
31237da
use userid for local storage
AfraHussaindeen Sep 20, 2024
bd0f185
Remove sub path
AfraHussaindeen Sep 22, 2024
7df8f40
improve the application
AfraHussaindeen Sep 22, 2024
52d98ba
Update license
AfraHussaindeen Sep 22, 2024
14a9e8a
Update filenames and remove index files
AfraHussaindeen Sep 22, 2024
d3fe27b
Update the readme
AfraHussaindeen Sep 22, 2024
89b57ac
Fix review comments
AfraHussaindeen Sep 22, 2024
6a735fe
Fixed review comments
AfraHussaindeen Sep 29, 2024
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
14 changes: 14 additions & 0 deletions samples/react-sample-app/.env
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# The hostname for the server, e.g., localhost or 127.0.0.1
HOST=localhost

# The port number for the server, e.g., 3000 or 8080
PORT=3000

# Disable host check for the development server, e.g., true or false
DISABLE_DEV_SERVER_HOST_CHECK=false

# Enable HTTPS for the server, e.g., true or false
HTTPS=true

# The base URL for the React application, e.g., /, /app or /my-app/sub-app
REACT_APP_BASE_URL=/
2 changes: 2 additions & 0 deletions samples/react-sample-app/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
dist
node_modules
201 changes: 201 additions & 0 deletions samples/react-sample-app/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

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.
74 changes: 74 additions & 0 deletions samples/react-sample-app/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Guardio Life - Onfido Connector Usage Example (Single Page Application)

This sample application demonstrates how to perform identity verification with Onfido using WSO2 Identity Server in a Single Page Application (SPA). The application simulates an insurance company called Guardio Life, where users can browse and select various insurance plans.

To ensure compliance and verify the age of potential customers, Guardio Life implements an identity and age verification process using Onfido before allowing users to select a plan. Here's how it works:

1. Users can view available insurance plans on the homepage.
2. Initially, the buttons for selecting plans are greyed out and not clickable.
3. Users are prompted to complete an identity and age verification process using Onfido.
4. The application integrates with Onfido to perform the verification.
5. Once the verification is successfully completed, the plan selection buttons become active and clickable.
6. Users can then proceed to select their desired insurance plan.

This sample showcases the seamless integration of identity verification in a real-world scenario, enhancing security and compliance for online insurance purchases while providing a clear user experience with visual cues about the verification status.

## Getting Started

### Prerequisites
- Ensure you have `Node.js` installed (version 10 or above).
- Ensure that a user account is created, and the *first name*, *last name*, and *date of birth* are correctly set to match the details on the document that will be used for verification.
AfraHussaindeen marked this conversation as resolved.
Show resolved Hide resolved

### Registering a Single Page Application in the WSO2 Identity Server Console

Follow the instructions in the [WSO2 Identity Server Documentation](https://is.docs.wso2.com/en/latest/guides/applications/register-single-page-app/) to register your application.

Ensure you add `https://localhost:3000/guardio-life/subscriptions` as a Redirect URL and also include `https://localhost:3000` under Allowed Origins.

### Configuring an Onfido Identity Verification Provider in the WSO2 Identity Server Console

Follow the instructions in the [Onfido Connector Documentation](https://github.com/wso2-extensions/identity-verification-onfido/blob/main/docs/config.md#configuring-onfido-identity-verification-provider-in-wso2-identity-server-console)

Note: Ensure that the necessary attribute mappings for the *Guardio Life* application are provided. Navigate to the **Attributes** tab and configure the following attribute mappings:

- first_name -> http://wso2.org/claims/givenname
- last_name -> http://wso2.org/claims/lastname
- dob -> http://wso2.org/claims/dob

These mappings ensure that the user's first name, last name, and date of birth are accurately synchronized between Onfido and WSO2 Identity Server, enabling both user identity verification and attribute value validation.

### Configuring the Sample Application

1. Navigate to the `identity-verification-onfido-sample-app/samples/react-sample-app/public` directory.
2. Open the `runtime-config.json` file and update it with your registered application and Onfido Identity Verification Provider details:

```json
{
"clientID": "<CLIENT_ID>",
"baseUrl": "https://<DOMAIN_NAME>/t/<TENANT_NAME>",
"signInRedirectURL": "https://localhost:3000",
"signOutRedirectURL": "https://localhost:3000",
"userPortalURL": "https://<DOMAIN_NAME>/t/<TENANT_NAME>/myaccount",
"scope": [ "openid", "profile", "internal_login"],
"identityVerificationProviderId": "<ONFIDO_IDVP_ID>"
}
```

### Running the Application

Run the following commands to install dependencies and start the application:

```bash
npm install && npm start
```
The application will open at [`https://localhost:3000`](https://localhost:3000).

### Changing the Application's Development Server Port

If you need to run the development server on a different port, follow these steps:

1. Update the `PORT` in the `.env` file located at the root of the application.
2. Update the `signInRedirectURL` and `signOutRedirectURL` in the `src/runtime-config.json` file.
3. Go to the Identity Server/Asgardeo Console and navigate to the **Protocol** tab of your application:
- Update the **Authorized Redirect URL**.
- Update the **Allowed Origins**.
43 changes: 43 additions & 0 deletions samples/react-sample-app/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/**
* Copyright (c) 2024, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
*
* WSO2 Inc. licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file except
* in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/

module.exports = {
env: {
test: {
plugins: ["@babel/plugin-transform-modules-commonjs"]
}
},
plugins: [
["@babel/plugin-proposal-decorators", { "legacy": true }],
"@babel/plugin-proposal-class-properties"
],
presets: [
[
"@babel/preset-env",
{
corejs: {
proposals: true,
version: "3.6"
},
useBuiltIns: "entry"
}
],
"@babel/preset-typescript",
"@babel/preset-react"
]
};
Loading
Loading