Dyte React UI Kit Samples

Contents

1. Introduction
2. About This Repository
3. Setting Up the Project
   • Prerequisites
   • Installation Steps
4. Usage
5. Contributing
6. License

Introduction

Dyte is a technology company specializing in real-time communication solutions. Our products are designed to enable seamless and efficient video interactions in various applications, ranging from virtual meetings to interactive live streaming. The offerings are known for their robust performance, scalability, and ease of integration.

About This Repository

This repository consists of all the different ways in which you can use Dyte's React UI Kit and other packages to its full extent to get the best live audio/video experience.

Samples

Here are the list of available samples at the moment.

1. Default Meeting UI
2. Using Background Transformer to modify your background
3. Audio Room
4. Facetime
5. Chat
6. Live Auction App

Usage

To use these samples you would need to do the following steps:

First, you'll need to create a meeting and add a participant to that meeting.

You can do so by going to https://docs.dyte.io/api?v=v2 and run the APIs in the API runner itself so you can quickly get started.

Make sure you've created your Dyte account at https://dev.dyte.io and have your Organization ID and API Key ready to use from the API Keys section.

1. Go to Create Meeting API and add your credentials and run the API with your request body, note the id you receive in resonse, this is the meeting id.
2. Go to Add Participant API and add a participant to the meeting with the meetingId you received in previous API call.

Once you're done, you'll get an authToken, which you can use in a sample as explained below.

Trying out a sample

Here are steps to try out the samples:

1. Clone the repo:

git clone git@github.com:dyte-io/react-samples.git

2. Change directory to the sample you want to try, for example: in default-meeting-ui:

cd samples/default-meeting-ui

3. Install the packages with your preferred package manager and start a development server and open up the page.

npm install
# and to start a dev server
npm run dev

4. Load the dev server in your browser and make sure you pass the authToken query in the URL.

http://localhost:5173/?authToken=<your-token>