Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aws-samples/simple-websockets-chat-app
This SAM application provides the Lambda functions, DynamoDB table, and roles to allow you to build a simple chat application based on API Gateway's new WebSocket-based API feature.
https://github.com/aws-samples/simple-websockets-chat-app
apigateway aws websockets
Last synced: 2 months ago
JSON representation
This SAM application provides the Lambda functions, DynamoDB table, and roles to allow you to build a simple chat application based on API Gateway's new WebSocket-based API feature.
- Host: GitHub
- URL: https://github.com/aws-samples/simple-websockets-chat-app
- Owner: aws-samples
- License: mit-0
- Created: 2018-12-17T20:44:42.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-16T12:19:58.000Z (10 months ago)
- Last Synced: 2024-08-02T06:24:34.915Z (5 months ago)
- Topics: apigateway, aws, websockets
- Language: JavaScript
- Size: 61.5 KB
- Stars: 679
- Watchers: 27
- Forks: 283
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# simple-websockets-chat-app
**Update**: _We have released an updated and more feature-rich Websocket chat application sample using AWS CDK that you can find [here](https://github.com/aws-samples/websocket-chat-application)._
This is the code and template for the `simple-websocket-chat-app`.
There are three functions contained within the directories and a `SAM` template that wires them up to a `DynamoDB` table and provides the minimal set of permissions needed to run the app:
```
.
├── README.md <-- This instructions file
├── onconnect <-- Source code onconnect
├── ondisconnect <-- Source code ondisconnect
├── sendmessage <-- Source code sendmessage
└── template.yaml <-- SAM template for Lambda Functions and DDB
```
# Deploying to your account
You have two choices for how you can deploy this code.
## Serverless Application Repository
The first and fastest way is to use AWS's Serverless Application Repository to directly deploy the components of this app into your account without needing to use any additional tools. You'll be able to review everything before it deploys to make sure you understand what will happen. Click through to see the [application details](https://serverlessrepo.aws.amazon.com/applications/arn:aws:serverlessrepo:us-east-1:729047367331:applications~simple-websockets-chat-app).
## AWS CLI commands
If you prefer, you can install the [AWS SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html) and use it to package, deploy, and describe your application. These are the commands you'll need to use:
```
sam deploy --guided
aws cloudformation describe-stacks \
--stack-name simple-websocket-chat-app --query 'Stacks[].Outputs'
```
**Note:** `.gitignore` contains the `samconfig.toml`, hence make sure backup this file, or modify your .gitignore locally.
## Testing the chat API
To test the WebSocket API, you can use [wscat](https://github.com/websockets/wscat), an open-source command line tool.
1. [Install NPM](https://www.npmjs.com/get-npm).
2. Install wscat:
```bash
$ npm install -g wscat
```
3. On the console, connect to your published API endpoint by executing the following command:
```bash
$ wscat -c wss://{YOUR-API-ID}.execute-api.{YOUR-REGION}.amazonaws.com/{STAGE}
```
4. To test the sendMessage function, send a JSON message like the following example. The Lambda function sends it back using the callback URL:
```bash
$ wscat -c wss://{YOUR-API-ID}.execute-api.{YOUR-REGION}.amazonaws.com/prod
connected (press CTRL+C to quit)
> {"action":"sendmessage", "data":"hello world"}
< hello world
```
## License Summary
This sample code is made available under a modified MIT license. See the LICENSE file.