@huddle01/react/README.md

The Huddle01 React SDK offers a comprehensive suite of hooks, methods and event listeners that allow for seamless real-time audio and video communication with minimal coding required.

# Huddle01 React SDK

![https://huddle01.app/images/Huddle01-Network.png](https://huddle01.app/images/Huddle01-Network.png)

<p align="center">
  <strong>People-powered
Communication</strong>
</p>

<h3 align="center">
  <a href="https://discord.com/invite/AZ5TRMMP55">Community</a>
  <span> · </span>
  <a href="https://huddle01.com/docs">Documentation</a>
</h3>


# React SDK

The Huddle01 React SDK offers a comprehensive suite of hooks, methods and event listeners that allow for seamless real-time audio and video communication with minimal coding required.

## Pre Requisites

Before using the React SDK, you must have Node.js installed on your machine. You can install Node.js using one of the following methods:

- Install Node.js with NVM by following the instructions on this **[GitHub page](https://github.com/nvm-sh/nvm)**
- Install Node.js with FNM by following the instructions on this **[GitHub page](https://github.com/Schniz/fnm)**
- Download Node.js from the official **[website](https://nodejs.org/)**

> **_Pro Tip :_** Use NVM or FNM to install Node.js as they help in version management
> and easy updation

After installing Node.js, verify it's installed by running the following command in your terminal:

```jsx
node --version
```

## Installing the packages:

To get started with the Huddle01 React SDK, you can install the package using npm or pnpm or bun:

```bash
npm install @huddle01/react
```

## Initializing the SDK:

After installing the package, you can initialize the SDK by using the **`HuddleProvider`** hook:

```tsx
import { HuddleProvider, HuddleClient } from '@huddle01/react';
 
const huddleClient = new HuddleClient({
  projectId: env.NEXT_PUBLIC_PROJECT_ID,
  options: {
    activeSpeakers: {
      size: 8,
    },
  },
});
 
...
<HuddleProvider client={huddleClient}>
  <App />
</HuddleProvider>
...
```


💡 For more information head to https://huddle01.com/docs

💡 For any help reach out to us on
[Discord](https://discord.com/invite/AZ5TRMMP55)