nestjs-server-sent-events - GitLite

KO | EN

gitlite — search

#dotnet #editor #linux #kubernetes #computer-vision #list #redis #rag #artificial-intelligence #hacktoberfest

nestjs-server-sent-events

(★ 18)

Example project of using Server-Sent Events with Nest.js

File Explorer

ZIP Download

- index.html
- app.controller.ts
- app.module.ts
- constants.ts
- main.ts
- notifications.service.ts
.eslintrc.js
.gitignore
.prettierrc
Dockerfile
nest-cli.json
package.json
README.md
tsconfig.build.json
tsconfig.json
yarn.lock

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

`git clone`

View Details ▼

Clone an existing repository.

git clone {{remote_repository_location}} {{path/to/directory}}

Clone an existing repository into a new directory (the default directory is the repository name):

git clone --recursive {{remote_repository_location}}

Clone an existing repository and its submodules:

git clone {{[-n|--no-checkout]}} {{remote_repository_location}}

Clone only the `.git` directory of an existing repository:

🔍

`yarn`

View Details ▼

JavaScript and Node.js package manager alternative.

yarn global add {{module_name}}

Install a module globally:

yarn install

Install all dependencies referenced in the `package.json` file (the `install` is optional):

yarn add {{module_name}}@{{version}}

Install a module and save it as a dependency to the `package.json` file (add `--dev` to save as a dev dependency):

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

This is a simple Nest.js application demonstrating the use of Server-Sent Events (SSE) to send real-time notifications to clients. The project includes a basic backend service to handle notifications and a frontend example to display them.

## Features

-   **Backend**: A Nest.js server that provides endpoints to post notifications and stream notifications to clients in real-time using SSE.
-   **Frontend**: A simple HTML page to demonstrate receiving notifications in real-time and displaying them with a notification badge.

## Installation

1. Clone the repository:

```bash
   git clone git@github.com:peterkracik/nestjs-server-sent-events.git
   cd nestjs-server-sent-events
   ```

2. Install the dependencies:

```bash
   yarn install
   ```

## Running the Application

1. Start the Nest.js server:

```bash
   yarn start:dev
   ```

The server will run on `http://localhost:3000`.
   Provide a query parameter `user` to the frontend to specify the user ID. For example, `http://localhost:3000/?user=1`.

## Endpoints

### POST /api/notifications

-   **Description**: Receives a new notification and adds it to the store.
-   **Request Body**:
  ```json
  {
    "message": "string",
    "userId": "string"
  }
  ```

### GET /api/notifications/:id

-   **Description**: Returns all notifications for a given user.
-   **Parameters**:
  - `id`: User ID

### SSE /api/notifications/:id/stream

-   **Description**: Returns a stream of notifications for a given user.
-   **Parameters**:
  - `id`: User ID

## Frontend Example

The frontend is a simple HTML page using Tailwind CSS for styling. It demonstrates how to:

-   Send notifications via a form.
-   Display notifications count using a badge.
-   Receive real-time notifications using SSE.

### How to Use

1. Open the `http://localhost:3000/?user=1` file in a browser.
2. Use the form to send notifications to a user.
3. The notification count badge will update in real-time as new notifications are received.

## Dependencies

-   `@nestjs/common`: Core Nest.js components.
-   `@nestjs/event-emitter`: Used to emit and listen to events within the application.
-   `rxjs`: Library for reactive programming using Observables.

## License

This project is licensed under the MIT License.