neo4j-client-sso/README.md

Single sign-on client (frontend) library for Neo4j products

# neo4j-client-sso

Single sign-on client (frontend) library for Neo4j products.

> IMPORTANT!
> This library requires the [window](https://developer.mozilla.org/en-US/docs/Web/API/Window) interface/object!

## Install

Run `yarn add neo4j-client-sso`

## Documentation

You can generate the documentation locally by running `yarn docs` and find the documentation under `/docs`.

## Development setup

1.  Clone this repo
2.  Install yarn globally (not required but recommended): `brew install yarn` or `npm install -g yarn`
3.  Install project dependencies: `yarn install`

## Enable debugging

Add the following entry in your web browser's [Local Storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) to enable the debugging mode even with a production build (so when NODE_ENV is equal to 'production'):
| Key | Value |
| ------ | ------ |
| OIDC/OAuth#EnableAuthDebugging | true |