Skip to content

clearverified/clear-verified-demo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Clear Verified Demo App

This is a demo app that can be used to simulate the Clear Verified flow and provide best practice in terms of implementation for our Web SDK. Our Web SDK can be integrated with a Modal UI or through a link and redirect.

You can read more about Clear Verified in our public docs at: https://docs.clearme.com/docs/verify-users-web.

If you have any questions, reach out to CLEAR Verified technical support

Set Up

Configure CLEAR

Work with your CLEAR account team to get your PROJECT_ID, and API_KEY.

In this sample app, we have two separate Clear Verified Projects demostrating a KYC verification flow and a Document based verification flow. Clear Verified can support any number of custom and modular verification flow and this app demostrates how you can integration two types of verification types in the same project

In addition, we setup both the Web Modal integration type and the link integration type. When running the app, you can choose on the Demo App homepage which flow to use.

Link Integration Setup

If you are using our link integration Ensure your config can callback to the correct REDIRECT_URI. Otherwise, after the verification, the end user will be stuck on the verfication status screen In this case we have defined our REACT_APP_REDIRECT_URI to http://localhost:3000/callback

Update .env file (lives in the base project directory). Input your PROJECT_ID, API_KEY

Running the Buildscript

For developers using MacOS, you can build the project and run it automatically with the file: mac_build.sh. Just navigate to the folder and run the following command:

./mac_build.sh

Manual Setup

You can also choose to manually run this project. Before getting started, ensure that you have the Docker installed on your machine

Docker Desktop is an additional UI tool that is free for individual users but needs a paid license for enterprises. If you choose to install Desktop Desktop, Docker Compose comes included.

If you choose not to install Docker Desktop, you can install Docker Compose and Colima

Run The App

Execute locally (localhost:3000)

  1. Clone the repository

    git clone https://github.com/poweredbyclear/Demo-Verify-React-Web.git
  2. Navigate into the project directory:

    cd Demo-Verify-React-Web
  3. Build and run the project using Docker Compose:

    docker-compose up --build

This command will build the Docker images and start the containers defined in the docker-compose.yml file.

  1. Go to localhost:3000 on your browser to get started

  2. For the best experience, open Developer Tools (right click -> inspect) and simulate a mobile viewport with the "device toolbar".

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published