Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aws-samples/amazon-ivs-real-time-for-web-demo
This repository contains a social real-time application for Web. The web app leverages Amazon IVS Real-time streaming and uses the Amazon IVS Broadcast SDK for the video and audio-only experiences.
https://github.com/aws-samples/amazon-ivs-real-time-for-web-demo
amazon-ivs audio-room aws broadcasting ivs-chat ivs-realtime livestreaming lvl-300 realtime vuejs web webrtc
Last synced: 11 days ago
JSON representation
This repository contains a social real-time application for Web. The web app leverages Amazon IVS Real-time streaming and uses the Amazon IVS Broadcast SDK for the video and audio-only experiences.
- Host: GitHub
- URL: https://github.com/aws-samples/amazon-ivs-real-time-for-web-demo
- Owner: aws-samples
- License: mit-0
- Created: 2024-11-15T00:42:15.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-01-24T17:56:09.000Z (18 days ago)
- Last Synced: 2025-01-24T18:33:38.768Z (18 days ago)
- Topics: amazon-ivs, audio-room, aws, broadcasting, ivs-chat, ivs-realtime, livestreaming, lvl-300, realtime, vuejs, web, webrtc
- Language: Vue
- Homepage: https://rt.ivs.rocks/
- Size: 511 KB
- Stars: 3
- Watchers: 10
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Amazon IVS Real-time for Web Demo
A demo web application intended as an educational tool to demonstrate how you can build a real-time collaborative UGC streaming experience with [Amazon IVS Real-time](https://ivs.rocks/real-time). Check out a hosted version of this demo at https://rt.ivs.rocks/.
**This project is intended for education purposes only and not for production usage.**
## Prerequisites
- [NodeJS](https://nodejs.org/) v20.10.0 and Node package manager (npm).
- To create and share your own real-time streams, you must deploy the [Amazon IVS Real-time Serverless Demo](https://github.com/aws-samples/amazon-ivs-real-time-serverless-demo). After deploying the serverless demo, note the outputs: `Customer ID` and `API key`.
- You may also deploy the serverless demo from the **Manage AWS Account** screen in the app settings. Refer to the [Setup - Serverless](#setup---serverless) section in this readme for more details.
## Setup - Webapp
To run the application locally, take the following steps:
1. Run: `npm ci`
2. Run: `npm run dev`
3. Open `http://localhost:5173` in your web browser and select `Continue` to enter the demo.
## Setup - Serverless
To create your own streams, you must deploy the [Amazon IVS Real-time Serverless Demo](https://github.com/aws-samples/amazon-ivs-real-time-serverless-demo).
Deploy using the command line:
1. Visit the [Amazon IVS Real-time Serverless Demo](https://github.com/aws-samples/amazon-ivs-real-time-serverless-demo) repository.
2. Follow the instructions in the README to deploy the application to your AWS account.
3. After deploying the serverless demo, note the outputs: `Customer ID` and `API key`.
4. While the app is running locally, visit `http://localhost:5173/custom` and enter the combined `Customer ID` and `API key` when prompted
- For example: `a1bcde23456f7g-abcDeFghIQaTbTxd0T95`
Deploy using the AWS web console:
1. While the app is running locally, visit `http://localhost:5173/settings/connect` and follow the instructions.
**IMPORTANT NOTE:** Joining a stage and streaming in the app will create and consume AWS resources, which will cost money.
## Known Issues and Limitations
- A list of known issues for the Amazon IVS Broadcast SDK is available on the following page: [Amazon IVS Web Broadcast SDK: Known Issues and Workarounds](https://aws.github.io/amazon-ivs-web-broadcast/docs/real-time-sdk-guides/known-issues)
- The application is meant for demonstration purposes and **not** for production use.
- This application is only tested and supported on the latest Desktop version of Chrome and Safari. Other browsers and devices may work with this tool, but are not officially supported at this time.
## About Amazon IVS
Amazon Interactive Video Service (Amazon IVS) is a managed live streaming and stream chat solution that is quick and easy to set up, and ideal for creating interactive video experiences. [Learn more](https://aws.amazon.com/ivs/).
- [Amazon IVS docs](https://docs.aws.amazon.com/ivs/)
- [User Guide](https://docs.aws.amazon.com/ivs/latest/userguide/)
- [API Reference](https://docs.aws.amazon.com/ivs/latest/APIReference/)
- [Setting Up for Streaming with Amazon Interactive Video Service](https://aws.amazon.com/blogs/media/setting-up-for-streaming-with-amazon-ivs/)
- [Learn more about Amazon IVS on IVS.rocks](https://ivs.rocks/)
- [View more demos like this](https://ivs.rocks/examples)
## License
This project is licensed under the MIT-0 License. See the LICENSE file.