Skip to content
This repository has been archived by the owner on Jan 4, 2023. It is now read-only.

Latest commit

 

History

History
50 lines (31 loc) · 3.66 KB

README.md

File metadata and controls

50 lines (31 loc) · 3.66 KB
Raw

⚠️ IMPORTANT ⚠️ This repository is no longer actively maintained and will be archived at the end of 2022

For a more scalable multi-platform solution using Amazon IVS Chat, refer to the following repositories:

Amazon IVS Simple Chat demo

A demo web application intended as an educational tool for demonstrating how you can build a very simple Chat backend. In conjunction with Amazon IVS, it can be used to build a compelling customer experience for live streams with chat use-cases.

This project is intended for education purposes only and not for production usage.

This is a serverless web application, leveraging Amazon IVS, AWS Lambda, and WebSockets. The web user interface is a single page application built using responsive web design frameworks and techniques, producing a native app-like experience tailored to the user's device.

The demo showcases how you can implement a simple chat client next to an Amazon IVS stream. Viewers are asked to enter their name the first time they begin chatting. Messages are sent in the format <Username> <Message> as part of each chat "bubble". Chat users can send plain text messages, text links, and emojis. Chat messages have a character limit of 510 characters.

Getting Started

IMPORTANT NOTE: Deploying this demo application in your AWS account will create and consume AWS resources, which will cost money.

This demo is comprised of two parts: serverless (the demo backend) and web-ui (the demo frontend).

  1. If you do not have an AWS account, please see How do I create and activate a new Amazon Web Services account?
  2. Log into the AWS console if you are not already. Note: If you are logged in as an IAM user, ensure your account has permissions to create and manage the necessary resources and components for this application.
  3. Test locally or deploy to your AWS account. The CloudFormation template will automate the serverless backend and Amazon IVS channel creation.

Known issues and limitations

  • The application was written for demonstration purposes and not for production use.
  • Currently only tested in the us-west-2 (Oregon) region. Additional regions may be supported depending on service availability.

About Amazon IVS

Amazon Interactive Video Service (Amazon IVS) is a managed live streaming solution that is quick and easy to set up, and ideal for creating interactive video experiences. Learn more.

Security

See CONTRIBUTING for more information.

License

This library is licensed under the MIT-0 License. See the LICENSE file.