Skip to content

Latest commit

 

History

History
127 lines (81 loc) · 3.52 KB

README.md

File metadata and controls

127 lines (81 loc) · 3.52 KB
Raw

Logo

React Sample App

A basic project demonstrating how you can integrate **dyte** in your React app.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

About The Project

A basic project demonstrating how you can integrate dyte in your React app.

very-basic

Choose from a list of available meeting rooms, or create a new Dyte meeting and join as a participant or a host.

Built With

Structure

React App structure:

├── src
│   ├── 📁 container // contains main screen page component.
│   ├── 📁 exampleComponent // sample example components
│   ├── App.tsx // page routes are defined here
│   ├── index.tsx // application js entry point

Getting Started

Please make sure you have an organization ID and API Key for your application. These can be obtained from the developer portal.

Installation

  1. Clone the repo
git clone https://github.com/dyte-in/react-sample-app.git
  1. Install NPM packages
npm install
  1. Create an .env file with your credentials. Use .env.example as a template.
cp .env.example .env
  1. Run the application
npm start

Application Flow

On opening http://localhost:3000 in your browser, the client will first make an api call to check list of available meeting rooms. If not, then you can create a meeting room by entering a title and then click on create room button. The newly created room can be seen under the meeting room list section.

You can select the example that you want to test from the select example section. You can also refer the example component code with the path provided.

Finally, you can test the example by joining any meeting room as a host or as a participant. On clicking the button, a new user will be created by making an api call and meeting room will be launched.

All mandatory credentials of a user (i.e. roomname, user authtoken etc.) that are required to launch the meetings are stored in session storage.

Usage

Choose from a list of examples and then join on any meeting room to test it live.

You can also refer the example component code with the path provided.

For documentation on APIs and client SDKs, please refer to our official documentation.

License

Distributed under the MIT License. See LICENSE for more information.