{"id":26067474,"url":"https://github.com/agoraio-community/videouikit-web-react","last_synced_at":"2025-03-08T21:44:51.420Z","repository":{"id":43190426,"uuid":"436294521","full_name":"AgoraIO-Community/VideoUIKit-Web-React","owner":"AgoraIO-Community","description":"A Web library to simply integrate Agora Video Calling or Live Video Streaming to your website with just a few lines of code.","archived":false,"fork":false,"pushed_at":"2024-05-07T19:18:44.000Z","size":4401,"stargazers_count":48,"open_issues_count":12,"forks_count":39,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-05-08T15:32:42.697Z","etag":null,"topics":["livestreaming","low-code","react","uikit","videocall","web","webcomponents"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AgoraIO-Community.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-12-08T15:20:32.000Z","updated_at":"2024-05-08T15:32:42.698Z","dependencies_parsed_at":"2024-04-11T20:26:32.592Z","dependency_job_id":"2b43beac-610f-4deb-8c82-7f916fd12f51","html_url":"https://github.com/AgoraIO-Community/VideoUIKit-Web-React","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO-Community%2FVideoUIKit-Web-React","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO-Community%2FVideoUIKit-Web-React/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO-Community%2FVideoUIKit-Web-React/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO-Community%2FVideoUIKit-Web-React/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AgoraIO-Community","download_url":"https://codeload.github.com/AgoraIO-Community/VideoUIKit-Web-React/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242614081,"owners_count":20158223,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["livestreaming","low-code","react","uikit","videocall","web","webcomponents"],"created_at":"2025-03-08T21:44:50.965Z","updated_at":"2025-03-08T21:44:51.406Z","avatar_url":"https://github.com/AgoraIO-Community.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [ARCHIVED] Agora React VideoUIKit \n\n**⚠️ This project is no longer maintained and has been archived.**  \nPlease note that this repository is now in a read-only state and will not receive any further updates or support.\nWe recommend migrating to the following alternatives:\n\n- **Agora SDK**: For developers seeking a customizable solution with full control over the user experience. [Learn more](https://www.agora.io/en/products/video-call/)\n- **Agora App Builder**: For those preferring a no-code approach to integrate real-time engagement features. [Get started](https://appbuilder.agora.io/)\n\nFor documentation and support, please visit the [Agora Documentation](https://docs.agora.io/en/).\n\n[![NPM](https://img.shields.io/npm/v/agora-react-uikit.svg)](https://www.npmjs.com/package/agora-react-uikit) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)\n\n\u003e Instantly integrate Agora video calling or streaming into your web application using a React based VideoUIKit.\n\n## Getting started\n### Requirements\n- [An Agora developer account](https://sso.agora.io/en/signup?utm_source=github\u0026utm_repo=Web-React-UIKit)\n- A React project\n\n### Installation\nTo a react application, add the following:\n\n```bash\nnpm i agora-react-uikit\n```\n\n### Usage\n\nThis UIKit contains a high level component called `AgoraUIKit`. You can check out code explanation [here](https://github.com/AgoraIO-Community//VideoUIKit-Web-React/wiki/Guide).\n\n**A simple sample app integrating Agora UI Kit:**\n```jsx\nimport React, {useState} from 'react';\nimport AgoraUIKit from 'agora-react-uikit';\n\nconst App = () =\u003e {\n  const [videoCall, setVideoCall] = useState(true);\n  const rtcProps = {\n    appId: '\u003cAgora App ID\u003e',\n    channel: 'test', // your agora channel\n    token: '\u003cYour channel Token\u003e' // use null or skip if using app in testing mode\n  };\n  const callbacks = {\n    EndCall: () =\u003e setVideoCall(false),\n  };\n  return videoCall ? (\n    \u003cdiv style={{display: 'flex', width: '100vw', height: '100vh'}}\u003e\n      \u003cAgoraUIKit rtcProps={rtcProps} callbacks={callbacks} /\u003e\n    \u003c/div\u003e\n  ) : (\n    \u003ch3 onClick={() =\u003e setVideoCall(true)}\u003eStart Call\u003c/h3\u003e\n  );\n};\n\nexport default App;\n```\n\n**Insert your Agora AppID and Token**.\n\n### Demo Project\nThere's a demo project in the repo [here](https://github.com/AgoraIO-Community/VideoUIKit-Web-React/tree/main/example).\n\n### Instructions for running the demo:\n1. Add your Agora App ID to `/example/src/App.tsx`\n2. Run `npm start` to start the bundler to build the library\n3. Execute `cd example \u0026\u0026 npm start` to run the example app\n\n## Documentation\n\nFor full documentation, see our [docs page](https://agoraio-community.github.io/VideoUIKit-Web-React/).\n\nYou can visit the [wiki](https://github.com/AgoraIO-Community/VideoUIKit-Web-React/wiki) for other examples and in depth guide.\n\nYou can also export the UIKit to use outside a React project (for example in a vanilla-js project) using web-components. Find out more in the `/web-component` directory.\n\n## UIKits\n\nThe plan is to grow this library and have similar offerings across all supported platforms. There are already similar libraries for [Android](https://github.com/AgoraIO-Community/VideoUIKit-Android), [iOS](https://github.com/AgoraIO-Community/VideoUIKit-iOS), [React Native](https://github.com/AgoraIO-Community/VideoUIKit-ReactNative), and [Flutter](https://github.com/AgoraIO-Community/VideoUIKit-Web-Flutter), so be sure to check them out.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagoraio-community%2Fvideouikit-web-react","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagoraio-community%2Fvideouikit-web-react","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagoraio-community%2Fvideouikit-web-react/lists"}