{"id":20268614,"url":"https://github.com/agoraio/video-sdk-samples-js","last_synced_at":"2026-06-05T03:31:50.633Z","repository":{"id":195812946,"uuid":"657382964","full_name":"AgoraIO/video-sdk-samples-js","owner":"AgoraIO","description":null,"archived":false,"fork":false,"pushed_at":"2024-02-27T16:35:11.000Z","size":11446,"stargazers_count":0,"open_issues_count":1,"forks_count":2,"subscribers_count":5,"default_branch":"main","last_synced_at":"2026-04-21T22:45:15.594Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AgoraIO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2023-06-23T00:17:16.000Z","updated_at":"2023-09-19T14:43:11.000Z","dependencies_parsed_at":"2023-09-19T18:26:44.290Z","dependency_job_id":"672149e3-3d8a-4043-9058-f73e10aefe5c","html_url":"https://github.com/AgoraIO/video-sdk-samples-js","commit_stats":null,"previous_names":["agoraio/video-sdk-samples-js"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/AgoraIO/video-sdk-samples-js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2Fvideo-sdk-samples-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2Fvideo-sdk-samples-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2Fvideo-sdk-samples-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2Fvideo-sdk-samples-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AgoraIO","download_url":"https://codeload.github.com/AgoraIO/video-sdk-samples-js/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2Fvideo-sdk-samples-js/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33928630,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-05T02:00:06.157Z","response_time":120,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-14T12:19:04.658Z","updated_at":"2026-06-05T03:31:50.617Z","avatar_url":"https://github.com/AgoraIO.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Agora Video SDK for Web reference app\n\nThis app demonstrates use of [Agora's Video SDK](https://docs.agora.io/en/video-calling/get-started/get-started-sdk) for real-time audio and video communication. It is a robust and comprehensive documentation reference app for Android, designed to enhance your productivity and understanding. It's built to be flexible, easily extensible, and beginner-friendly.\n\nClone the repo, run and test the samples, and use the code in your own project. Enjoy.\n\n- [Agora Video SDK for Web reference app](#agora-video-sdk-for-web-reference-app)\n  - [Samples](#samples)\n  - [Prerequisites](#prerequisites)\n  - [Run this project](#run-this-project)\n  - [Contact](#contact)\n\n\n## Samples  \n\nThe runnable code examples are:\n\n- [SDK quickstart](./src/sdk_quickstart/) - the minimum code you need to integrate low-latency, high-concurrency\n  video calling features into your app using Video SDK.\n- [Secure authentication with tokens](src/authentication_workflow/) - quickly set up an authentication token server, retrieve a token from the server, and use it to connect securely to Video SDK channel.\n- [Call quality best practice](./src/call_quality/) - ensure optimal audio and video quality in your app.\n- [Secure channels with encryption](./src/channel_encryption/) - integrate built-in encryption into your app using Video SDK..\n\n\n## Prerequisites\n\nBefore getting started with this reference app, ensure you have the following set up:\n\n- A [supported browser](../reference/supported-platforms#browsers).\n- Physical media input devices, such as a camera and a microphone.\n- The [pnpm](https://pnpm.io/installation#using-npm) package manager.\n\n\n## Run this project\n\nTo run the sample projects in this folder, take the following steps:\n\n1. **Clone the repository**\n\n    To clone the repository to your local machine, open Terminal and navigate to the directory where you want to clone the repository. Then, use the following command:\n\n    ```bash\n    git clone https://github.com/AgoraIO/video-sdk-samples-js.git\n    ```\n\n1. **Install the dependencies** \n\n    Open Terminal in the root directory of this project and run the following command:\n\n    ```bash\n    pnpm install\n    ```\n \n1. **Modify the project configuration**\n\n   The app loads connection parameters from [`./src/agora_manager/config.json`](./src/agora_manager/config.json)\n   . If a valid `serverUrl` is provided, all samples use a token server to obtain a token except the **SDK quickstart** project that uses the `rtcToken`. If a `serverUrl` is not specified, all samples except **Secure authentication with tokens** use the `rtcToken` from `config.json`.\n \n   Ensure that the file is populated with the required parameter values before running the application.\n\n    - `uid`: The user ID associated with the application.\n    - `appId`: (Required) The unique ID for the application obtained from [Agora Console](https://console.agora.io). \n    - `channelName`: The default name of the channel to join.\n    - `token`:An token generated for `channelName`. You generate a temporary token using the [Agora token builder](https://agora-token-generator-demo.vercel.app/).\n    - `serverUrl`: The URL for the token generator. See [Secure authentication with tokens](authentication-workflow) for information on how to set up a token server.\n    - `tokenExpiryTime`: The time in seconds after which a token expires.\n\n2. **Build and run the project**\n\n   In the project folder, open Terminal and run the following command:\n\n    ``` bash\n    pnpm dev\n    ```\n\n    You open the project at the URL shown in your terminal.\n\n3. **Run the samples in the reference app**\n\n   Choose a sample from the dropdown and test the code.\n\n## Contact\n\nIf you have any questions, issues, or suggestions, please file an issue in our [GitHub Issue Tracker](https://github.com/AgoraIO/video-sdk-samples-js/issues).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagoraio%2Fvideo-sdk-samples-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagoraio%2Fvideo-sdk-samples-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagoraio%2Fvideo-sdk-samples-js/lists"}