Giter Club home page Giter Club logo

relay's Introduction

Relay

A free video conferencing app made with React, Typescript, Express.js, Redis, and Agora SDK which uses webRTC protocol under the hood.

Github Release

Version

MIT License

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

AGORA_APP_ID

AGORA_APP_CERTIFICATE

DB_URL

API Reference

Get room ID

  GET /api/get-room-id

Generate room ID and add it to database.

Verify room ID

  GET /api/verify-room-id/${roomId}
Parameter Type Description
roomId string Required. Room ID to be verified

Check if the room ID is valid by querying the database.

Get access token

  GET /api/get-access-token?roomId=${roomId}&username=${username}
Parameter Type Description
roomId string Required. Room ID
username string Required. Username of client

Get access token for the given room ID and also add username to database.

Get username

  GET /api/get-username/${uid}
Parameter Type Description
uid string Required. UID of the user

Get username of the remote user with the given UID.

Delete username

  DELETE /api/delete-username/${username}
Parameter Type Description
username string Required. Username of client

Delete username of the client from database when leaving room.

Authors

Tech Stack

Client: React, Redux, SCSS, Typescript, Vite.

Server: Node, Express, Typescript, Redis.

Features

  • Video conferencing with upto 20 people in a call
  • Switch cameras on supported devices
  • Screen sharing with audio on supported devices
  • Floating client video in 2 user call
  • Fullscreen mode
  • Progressive Web App (PWA)

Screenshots

Run Locally

Clone the project

  git clone https://github.com/rohitman47/relay.git

Go to the project directory

  cd relay

Install dependencies

  npm install

Start the server

  npm run dev

Demo

https://relay.rohitman47.xyz

relay's People

Contributors

rohitxdev avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.