Welcome to the Catalyst Docs!

Catalyst is an open-source react component that aims to provide reliable and scalable video chat. A functioning build be integrated in minutes with a few lines of code.

Installation

Install Catalyst in any of your projects by running

xxxxxxxxxx

npm i catalyst-vc-react

or

xxxxxxxxxx

yarn add catalyst-vc-react

The latest npm version can be found on the npm registry here.

Importation

xxxxxxxxxx

import CatalystChat from "catalyst-vc-react"

Implementation

Finally, paste the following component wherever you want to use it in your project, and enter the two required props: room and appId.

room creates a new call with the passed name, and appId is a unique project identifier used to authenticate your instance of the Catalyst client with our servers. You will need a Catalyst appId API key to connect to our servers. This can be obtained in under a minute by visiting the API keys tab of our management portal.

xxxxxxxxxx

    <CatalystChat

            room="ROOM_NAME"

            appId="YOUR_CATALYST_PROJECT_ID"

            name="MEMBER_NAME"

            onEndCall={() => console.log('Call ended!')}

        />

Our servers are free for your first 30 monthly active users, which means they should not cost you anything in development (and possibly production)!

Compile to localhost, and that's it! In less than three lines of code you have functioning, high-quality video chat in your project.

Catalyst is heavily customizable, which you can learn about in the rest of the documentation!