Development setup

Prerequisites

• Node v16

Install dependencies

yarn setup

Setup environment variables

Create an .env file and copy the variables from .env.example

Run it locally

Locally, this project uses the free version of ngrok to enable redirects and webhook processing. Sign up for a free account and go through first time setup.

To start the application run the following command

yarn dev

Your personalized OAuth redirect URL and OAuth webhook URL will be logged in the console. Update your application settings on the Checkr Dashboard with the logged values.

OAuth webhook URL  https://90f1-34-236-51-55.ngrok.io/api/checkr/webhooks
OAuth redirect URL  https://90f1-34-236-51-55.ngrok.io/api/checkr/oauth

Run tests

yarn test:backend

yarn test:frontend

VS Code Recommended Settings

The .vscode folder contains opt-in Workspace Settings and Extension Recommendations that the Checkr team recommends using when working on this repository.

Unknown issues

msw testing library has a bug in node17 and node18

This Node V17 and v18 MSW bug will cause issues in some of our tests. While these problems are being fixed, we are using node v16 for now.