{"id":21427859,"url":"https://github.com/100mslive/web-sdks","last_synced_at":"2025-05-16T14:08:24.656Z","repository":{"id":217807335,"uuid":"429826515","full_name":"100mslive/web-sdks","owner":"100mslive","description":"Web SDKs for 100ms","archived":false,"fork":false,"pushed_at":"2025-05-15T09:11:11.000Z","size":71505,"stargazers_count":29,"open_issues_count":3,"forks_count":39,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-05-15T09:15:13.945Z","etag":null,"topics":["100mslive","prebuilt","streaming","video-conferencing","webrtc"],"latest_commit_sha":null,"homepage":"https://www.100ms.live/docs/javascript/v2/quickstart/mental-model","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/100mslive.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-11-19T14:28:37.000Z","updated_at":"2025-05-15T09:09:49.000Z","dependencies_parsed_at":"2024-05-01T20:15:46.411Z","dependency_job_id":"9200c446-2744-4868-a1a6-e83605bc1a43","html_url":"https://github.com/100mslive/web-sdks","commit_stats":null,"previous_names":["100mslive/web-sdks"],"tags_count":102,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/100mslive%2Fweb-sdks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/100mslive%2Fweb-sdks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/100mslive%2Fweb-sdks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/100mslive%2Fweb-sdks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/100mslive","download_url":"https://codeload.github.com/100mslive/web-sdks/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254544146,"owners_count":22088807,"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":["100mslive","prebuilt","streaming","video-conferencing","webrtc"],"created_at":"2024-11-22T22:07:29.809Z","updated_at":"2025-05-16T14:08:19.648Z","avatar_url":"https://github.com/100mslive.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Web SDKs\n\n[![Lint, Test and Build](https://github.com/100mslive/web-sdks/actions/workflows/lint-test-build.yml/badge.svg)](https://github.com/100mslive/web-sdks/actions/workflows/lint-test-build.yml)\n[![Activity](https://img.shields.io/github/commit-activity/m/100mslive/web-sdks.svg)](https://www.100ms.live/docs/javascript/v2/release-notes/release-notes)\n[![License](https://img.shields.io/npm/l/@100mslive/hms-video-store)](https://www.100ms.live/)\n[![Documentation](https://img.shields.io/badge/Read-Documentation-blue)](https://www.100ms.live/docs/javascript/v2/quickstart/javascript-quickstart)\n[![Register](https://img.shields.io/badge/Contact-Know%20More-blue)](https://dashboard.100ms.live/register)\n\nThis monorepo contains all the packages required to integrate 100ms on the web.\n\n## What is included?\n\nThe packages folder contains all the SDK's of 100ms. Here is a brief overview of them:\n\n| Directory | Package | Description | Link |\n|--|--|--|--|\n| `hms-video-store` | `@100mslive/hms-video-store` | This package contains the core SDK and the reactive store parts. | [README](./packages/hms-video-store) |\n| `react-sdk` | `@100mslive/react-sdk` | This contains the base React Hooks and some commonly used functionalities as React Hooks. | [README](./packages/react-sdk) |\n| `roomkit-react` | `@100mslive/roomkit-react`| This contains the React components used in the Prebuilt and the Prebuilt component itself. | [README](./packages/roomkit-react) |\n| `roomkit-web` | `@100mslive/roomkit-web` | This is a web component port of the `HMSPrebuilt` component from the `roomkit-react`. If you are not using React, this can be used as a web component. | [README](./packages/roomkit-web)|\n| `hls-player` | `@100mslive/hls-player` | This is a HLS player offered by 100ms that can be used to play live video streams. | [README](./packages/hls-player) |\n| `hms-whiteboard` | `@100mslive/hms-whiteboard` | This contains APIs for integrating Whiteboard collaboration into your conferencing sessions. | [README](./packages/hms-whiteboard) |\n| `hms-virtual-background` | `@100mslive/hms-virtual-background` | This contains the Virtual Background plugin provided by 100ms. | [README](./packages/hms-virtual-background) |\n| `react-icons` | `@100mslive/react-icons` | This contains all the icons used in the 100ms prebuilt. | [README](./packages/react-icons) |\n\nFor full documentation, visit [100ms.live/docs](https://www.100ms.live/docs)\n\n## How to integrate?\n\nThe 100ms SDK gives you everything you need to build scalable, high-quality live video and audio experiences.\n\n**There are two ways you can add 100ms to your apps:**\n\n## 1. Custom UI\n   - 100ms SDKs are powerful and highly extensible to build and support all custom experiences and UI.\n   - **Related packages include:** `@100mslive/react-sdk`, `@100mslive/hms-video-store` and `@100mslive/react-icons`.\n   - Get started with integrating the SDK using the [How to Guide](https://www.100ms.live/docs/javascript/v2/how-to-guides/install-the-sdk/integration).\n\n\u003e Navigate to `react-sdk` for the base React Hooks and some commonly used functionalities by clicking [here](./packages/react-sdk).\n\n## 2. 100ms Prebuilt\n    - 100ms Prebuilt is a high-level abstraction with no-code customization that enables you to embed video conferencing and/or live streaming UI—with a few lines of code.\n    - **Related packages include:** `roomkit-react` and `roomkit-web`.\n    - Get started with 100ms Prebuilt using the [Prebuilt Quickstart for Web](https://www.100ms.live/docs/javascript/v2/quickstart/prebuilt-quickstart).\n\n\u003e Navigate to `roomkit-react` for the React components used in Prebuilt and the Prebuilt component itself by clicking [here](./packages/roomkit-react).\n\n![Banner](prebuilt-banner.png)\n\n### 100ms Prebuilt Cross Platform Support\n\n| Client       | Repository                                                                                                     | Docs                                                                             | Example                                                                                                                           |\n| ------------ | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| Web          | [web-sdks](https://github.com/100mslive/web-sdks/tree/main/packages/roomkit-react)                             | [Link](https://www.100ms.live/docs/javascript/v2/quickstart/prebuilt-quickstart) | [prebuilt-react-integration](https://github.com/100mslive/web-sdks/tree/main/examples/prebuilt-react-integration)                 |\n| Android      | [100ms-android](https://github.com/100mslive/100ms-android/tree/release-v2/room-kit)                           | [Link](https://www.100ms.live/docs/android/v2/quickstart/prebuilt-android)       | [AndroidPrebuiltDemo](https://github.com/100mslive/AndroidPrebuiltDemo)                                                           |\n| iOS          | [100ms-roomkit-ios](https://github.com/100mslive/100ms-roomkit-ios)                                            | [Link](https://www.100ms.live/docs/ios/v2/quickstart/prebuilt)                   | [100ms-roomkit-example](https://github.com/100mslive/100ms-roomkit-example)                                                       |\n| Flutter      | [100ms-flutter](https://github.com/100mslive/100ms-flutter/tree/main/packages/hms_room_kit)                    | [Link](https://www.100ms.live/docs/flutter/v2/quickstart/prebuilt)               | [hms_room_kit/example](https://github.com/100mslive/100ms-flutter/tree/main/packages/hms_room_kit/example)                        |\n| React Native | [100ms-react-native](https://github.com/100mslive/100ms-react-native/tree/main/packages/react-native-room-kit) | [Link](https://www.100ms.live/docs/react-native/v2/quickstart/prebuilt)          | [react-native-room-kit/example](https://github.com/100mslive/100ms-react-native/tree/main/packages/react-native-room-kit/example) |\n\n## Setup\n\n### Local Setup\n\n\u003e Node version 18.0.0 or later\n\nif you are using a different version in other projects, use [nvm](https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating) to manage node versions.\n\n```bash\ngit clone https://github.com/100mslive/web-sdks.git\ncd web-sdks\nyarn install\nyarn build\n```\n\n### Running Sample Prebuilt\n\n```bash\ncd examples/prebuilt-react-integration\nyarn dev\n```\n\n`http://locahost:\u003cport\u003e/\u003croom-code\u003e`\n\nOnce you run `yarn dev`, the localhost link with the port will be generated automatically. Just get the roomCode from [100ms dashboard](https://dashboard.100ms.live) and append at the end\n\n### Testing Changes Locally\n\nRun `yarn start` by navigating to the package you are making changes to, the changes should reflect in the above sample app.\n\nFor example, if you are making changes in roomkit-react(prebuilt), run `yarn start` in that package. The sample app should auto reload.\n\n\u003e Note: Make sure `yarn build` is run atleast once before using `yarn start`.\n\n### Deploying Your Changes\n\nOnce you have forked the repository and tested your changes on the local build, you can follow the steps below to deploy to Vercel as an example:\n\n- Import the fork repository\n- Set `examples/prebuilt-react-integration` as the root directory\n- Use the Create React App preset and update the build and install commands `Project Settings` to use the root level scripts\n  - install: `cd ../../ \u0026\u0026 yarn install`\n  - build: `cd ../../ \u0026\u0026 yarn build`\n\nFor reference:\n\n![Project Settings](./project-settings.png)\n\n\nOnce the app has been deployed, you can append the room code at the end of the deployment URL to preview your changes\n\n### Maintaining A Forked Version\n\nThe following command will build the roomkit-react package and generate a .tgz file:\n\n```bash\nyarn \u0026\u0026 yarn build;\ncd packages/roomkit-react;\nyarn pack\n```\n\nPush your changes and the .tgz file to the forked repository and in the package.json of the app you are building, use the following link for the roomkit-react package:\n\n```\n\"@100mslive/roomkit-react\":\"https://github.com/\u003cuser_name\u003e/web-sdks/raw/main/packages/roomkit-react/\u003ctgz_file_name\u003e.tgz\",\n```\n\nRe-install the dependencies after updating the package.json and build using the following command:\n\n```\nyarn \u0026\u0026 yarn build\n```\n\nYou can now import the HMSPrebuilt component in the same way as before:\n\n```\nimport { HMSPrebuilt } from '@100mslive/roomkit-react';\n```\n\n## Contributing\n\nWe welcome external contributors or anyone excited to help improve 100ms SDKs. If you'd like to get involved, check out our [contribution guide](./DEVELOPER.MD), and get started exploring the codebase.\n\n## Community \u0026 Support\n\n- [GitHub Issues](https://github.com/100mslive/web-sdks/issues) - Submit any bugs or errors you encounter using the Web SDKs.\n- [Contact](https://www.100ms.live/contact) - Reach out to 100ms team to get pricing information, understand how we can help you go live, or to learn more about the platform.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F100mslive%2Fweb-sdks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F100mslive%2Fweb-sdks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F100mslive%2Fweb-sdks/lists"}