https://github.com/ably-labs/sse-dotnet

Demo application how to do server-sent events in a .NET 7 minimal web API.
https://github.com/ably-labs/sse-dotnet

demo dotnet server-sent-events sse webapi

Last synced: 18 days ago
JSON representation

Demo application how to do server-sent events in a .NET 7 minimal web API.

• Host: GitHub
• URL: https://github.com/ably-labs/sse-dotnet
• Owner: ably-labs
• License: apache-2.0
• Created: 2022-11-01T10:25:48.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-28T16:51:36.000Z (about 2 years ago)
• Last Synced: 2024-11-13T13:04:28.328Z (3 months ago)
• Topics: demo, dotnet, server-sent-events, sse, webapi
• Language: C#
• Homepage:
• Size: 1.42 MB
• Stars: 0
• Watchers: 7
• Forks: 1
• 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

        
# Server-Sent Events in .NET 7 minimal web API

## Description

This repository contains a .NET 7 minimal web API example how to use Server-Sent Events (SSE) to stream data from a server to a client.

![Server-Sent events shown in the browser](media/sse-browser-network_1920.gif)

## Tech stack

The project uses the following components:

- [.NET 7](https://dotnet.microsoft.com/download/dotnet/7.0), version 7 of the .NET SDK.

- [Lib.AspNetCore.ServerSentEvents](https://github.com/tpeczek/Lib.AspNetCore.ServerSentEvents), a library that provides Server-Sent Events for ASP.NET Core.

## Building & running locally

The solution consists of two parts:

- The minimal web API, located in the `api` folder. This API will sent the events.

- An `index.html` file located in the root, that acts as the client. This client will receive the events.

### Prerequisites

- An IDE that supports C#/.NET to build and run the web API, I'm using [VS Code](https://code.visualstudio.com/) with the [C# extension](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp).

- A way to locally host the `index.html` file. I'm using the [Live Server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer) extension for VS Code.

> If you use VSCode to open this repository, both the *C#* and *Live Server* extensions will be suggested to you to install.

### Running locally

1. Clone this repo and open the folder in VS Code.

2. Open the `index.html` file with the Live Server extension.

   - This will open a browser window with the `index.html` file at [http://127.0.0.1:5500/index.html](http://127.0.0.1:5500/index.html) that only shows the heading: '*Weather forecast using Server-Sent Events*'.

3. Run the web API by pressing `F5` in VS Code.

   - This will open an empty browser window at [http://localhost:5011/](http://localhost:5011/).

   - You'll see a message like '*This localhost page can’t be found*'. This is expected since the API doesn't have a default route or any UI.

The weather forecast page (at [127.0.0.1:5500/index.html](http://127.0.0.1:5500/index.html)) will now update every 2 seconds with new data.

## Contributing

Want to help contributing to this project? Have a look at our [contributing guide](CONTRIBUTING.md)!

## More info

If you have any questions or comments about this demo please join our [Discord](https://go.ably.com/discord) and have a chat!

- [Join our Discord server](https://go.ably.com/discord)

- [Follow us on Twitter](https://twitter.com/ablyrealtime)

- [Use our SDKs](https://github.com/ably/)

- [Visit our website](https://ably.com)

---

[![Ably logo](https://static.ably.dev/badge-black.svg?sse-dotnet)](https://ably.com)