Skip to main content

​
Install the Package

Add the WellPlayed React SDK to your project using your preferred package manager: 
npm install @well-played.gg/react-sdk

​
Peer Dependencies

The React SDK requires the following peer dependencies to be installed in your project: 
{
  "peerDependencies": {
    "@types/react": "^19.0.0",
    "@types/react-dom": "^19.0.0"
  }
}
Make sure you have React 19.0.0 or higher installed in your project. The SDK is built to work with modern React applications.

​
Key Dependencies

The SDK includes the following key dependencies that power its functionality:

Authentication

@axa-fr/react-oidc for OpenID Connect authentication

Rich Text

TipTap extensions for rich text content rendering

TypeScript SDK

@well-played.gg/typescript-sdk for API integration

Apollo Client

GraphQL client for data fetching (included via TypeScript SDK)

​
Next Steps

1

Get your credentials

Obtain your App Client ID from the WellPlayed Console
2

Configure the provider

Set up the WellPlayedProvider in your applicationLearn more about the provider →
3

Add authentication

Implement OIDC authentication flowLearn more about authentication →

Build docs developers (and LLMs) love

Get started for freeTalk to us